docs: make asciinema README markdown so sphinx ignores it (1.4-maint)#9939
Merged
ThomasWaldmann merged 1 commit intoJul 22, 2026
Conversation
docs/misc/asciinema/README.rst was picked up by sphinx but not part of any toctree, causing a "document isn't included in any toctree" warning in CI. As this README is developer notes, not part of the built docs, rename it to README.md: conf.py has source_suffix = '.rst', so sphinx ignores markdown. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01WRRe8BEFk4sV2GHVxDRo5A
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Same fix as #9938, for the
1.4-maintbranch.docs/misc/asciinema/README.rstis picked up by sphinx but not part of any toctree, producing a CI warning:This README is developer notes, not part of the built documentation. Renaming it to
README.mdfixes the warning:conf.pysetssource_suffix = '.rst', so sphinx ignores markdown files entirely. Nothing referenced it in a toctree, so no other changes are needed.🤖 Generated with Claude Code