Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork32k
[3.13] gh-127833: Docs: Add agrammar-snippet directive & replaceproductionlist (GH-127835)#129689
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
base:3.13
Are you sure you want to change the base?
Conversation
…roductionlist` (pythonGH-127835)As a first step toward aligning the grammar documentation with Python's actualgrammar, this overrides the ReST `productionlist` directive to:- use `:` instead of the `::=` symbol- add syntax highlighting for strings (using a Pygments highlighting class)All links and link targets should be preserved. (Unfortunately, this reachesinto some Sphinx internals; I don't see a better way to do exactly whatSphinx does.)This also adds a new directive, `grammar-snippet`, which formats the snippetalmost exactly like what's in the source, modulo syntax highlighting andkeeping the backtick character to mark links to other rules.This will allow formatting the snippets as in the grammar file(file:///home/encukou/dev/cpython/Doc/build/html/reference/grammar.html).The new directive is applied to two simple rules in toplevel_components.rst---------(cherry picked from commit58a4357)Co-authored-by: Petr Viktorin <encukou@gmail.com>Co-authored-by: Blaise Pabon <blaise@gmail.com>Co-authored-by: William Ferreira <wqferr@gmail.com>Co-authored-by: bswck <bartoszpiotrslawecki@gmail.com>Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
Let's not merge the backport just yet. I'd like to see this change go through the release process first. |
It should be merged together with a follow-up PR,#129692. If at all. |
I'm considering to backporting this for the syntax highlighting, but the upcoming grammar docs improvements are another matter. Those are tied to thecurrent grammar, verifying them is a fiddly manual process, and they're interlinked in complex ways -- a token in some grammar rule might need to move to another rule in another file, which Git won't catch as a conflict, and the nonexistent tests won't either (of course I'dlike to add tests, but that does require more automation, and in the current approach, rewriting the prose needs to come first.) |
Uh oh!
There was an error while loading.Please reload this page.
As a first step toward aligning the grammar documentation with Python's actual
grammar, 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 snippetalmost 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
(file:///home/encukou/dev/cpython/Doc/build/html/reference/grammar.html).
The new directive is applied to two simple rules in toplevel_components.rst
(cherry picked from commit58a4357)
Co-authored-by: Petr Viktorinencukou@gmail.com
Co-authored-by: Blaise Pabonblaise@gmail.com
Co-authored-by: William Ferreirawqferr@gmail.com
Co-authored-by: bswckbartoszpiotrslawecki@gmail.com
Co-authored-by: Adam Turner9087854+aa-turner@users.noreply.github.com
📚 Documentation preview 📚:https://cpython-previews--129689.org.readthedocs.build/