gh-127833: Fix grammar snippet formatting for help() output #129692
+326
−307
Conversation
This file contains 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
Change pydoc_data to show the "input" of grammar snippet directives, which is formatted the way we want. See also this Sphinx issue: sphinx-doc/sphinx#13302 And: sphinx-doc/sphinx#4454 A known issue is cross-grammar links, like those in the string format specification mini-language, which render as reST source: element_index: `~python-grammar:digit`+ | `index_string` I don't see a good way to fix this before Sphinx is refactored.
This is usually done at release time.
hugovk
reviewed
Feb 6, 2025
|
(re: https://github.com/python/cpython/actions/runs/13162643246/job/36735040454?pr=129692, I've updated the branch from |
|
Thank you! |
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
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.
Change pydoc_data to show the "input" of grammar snippet
directives, which is formatted the way we want.
See also this Sphinx issue: sphinx-doc/sphinx#13302
And: sphinx-doc/sphinx#4454
A known issue is cross-grammar links, like those in
the string format specification mini-language, which render
as reST source:
I don't see a good way to fix this before Sphinx is refactored.
📚 Documentation preview 📚: https://cpython-previews--129692.org.readthedocs.build/