gh-127833: Docs: Add a grammar-snippet directive & replace productionlist#127835
Merged
encukou merged 20 commits intopython:mainfrom Feb 5, 2025
Merged
gh-127833: Docs: Add a grammar-snippet directive & replace productionlist#127835encukou merged 20 commits intopython:mainfrom
grammar-snippet directive & replace productionlist#127835encukou merged 20 commits intopython:mainfrom
Conversation
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in 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.
As a first step to what's proposed in the issue, this overrides the ReST
productionlistdirective to::instead of the::=symbolAll links and link targets should be preserved. (Unfortunately, this reaches into some Sphinx internals; I don't see a better way to do exactly what Sphinx does.)
This also adds a new directive,
grammar-snippet, which formats the snippet almost exactly like what's in the source, modulo syntax highlighting and keeping the backtick character to mark links to other rules.This will allow formatting the snippets as in the grammar file (most importantly: to remove the the indentation that Sphinx adds to align the text).
I'd appreciate if a Sphinx expert could take a look to see if there's a better way to do something :) cc @AA-Turner
📚 Documentation preview 📚: https://cpython-previews--127835.org.readthedocs.build/