Title: [3.12] gh-127833: Docs: Add a `grammar-snippet` directive & replace `productionlist` (GH-127835) by miss-islington · Pull Request #129690 · python/cpython · GitHub
Open Graph Title: [3.12] gh-127833: Docs: Add a `grammar-snippet` directive & replace `productionlist` (GH-127835) by miss-islington · Pull Request #129690 · python/cpython
X Title: [3.12] gh-127833: Docs: Add a `grammar-snippet` directive & replace `productionlist` (GH-127835) by miss-islington · Pull Request #129690 · python/cpython
Description: As a first step toward aligning the grammar documentation with Python's actual grammar, 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 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 (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 commit 58a4357) 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 Issue: gh-127833 📚 Documentation preview 📚: https://cpython-previews--129690.org.readthedocs.build/
Open Graph Description: As a first step toward aligning the grammar documentation with Python's actual grammar, this overrides the ReST productionlist directive to: use : instead of the ::= symbol add syntax highligh...
X Description: As a first step toward aligning the grammar documentation with Python's actual grammar, this overrides the ReST productionlist directive to: use : instead of the ::= symbol add syntax high...
Opengraph URL: https://github.com/python/cpython/pull/129690
X: @github
Domain: github.com
| route-pattern | /:user_id/:repository/pull/:id/files(.:format) |
| route-controller | pull_requests |
| route-action | files |
| fetch-nonce | v2:58c9d54f-91bf-fb63-9e00-f4a57b0a11f8 |
| current-catalog-service-hash | ae870bc5e265a340912cde392f23dad3671a0a881730ffdadd82f2f57d81641b |
| request-id | CE3C:22EDB8:2A45871:37B8C62:696B2B5A |
| html-safe-nonce | 6a4ac14570df8d23f9400b766e21504c69d85d4fe0fb9de98c5d1b2e2b9d5434 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJDRTNDOjIyRURCODoyQTQ1ODcxOjM3QjhDNjI6Njk2QjJCNUEiLCJ2aXNpdG9yX2lkIjoiMzQzNDk3MjMyOTUwNDYxNTI1OCIsInJlZ2lvbl9lZGdlIjoiaWFkIiwicmVnaW9uX3JlbmRlciI6ImlhZCJ9 |
| visitor-hmac | 7ac0c1b3176a706e9f8f472c9e623f8658f1c12e6c9fbcd6f6864b348bc6a7bb |
| hovercard-subject-tag | pull_request:2317873402 |
| github-keyboard-shortcuts | repository,pull-request-list,pull-request-conversation,pull-request-files-changed,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/python/cpython/pull/129690/files |
| twitter:image | https://avatars.githubusercontent.com/u/31488909?s=400&v=4 |
| twitter:card | summary_large_image |
| og:image | https://avatars.githubusercontent.com/u/31488909?s=400&v=4 |
| og:image:alt | As a first step toward aligning the grammar documentation with Python's actual grammar, this overrides the ReST productionlist directive to: use : instead of the ::= symbol add syntax highligh... |
| og:site_name | GitHub |
| og:type | object |
| hostname | github.com |
| expected-hostname | github.com |
| None | 5f99f7c1d70f01da5b93e5ca90303359738944d8ab470e396496262c66e60b8d |
| turbo-cache-control | no-preview |
| diff-view | unified |
| go-import | github.com/python/cpython git https://github.com/python/cpython.git |
| octolytics-dimension-user_id | 1525981 |
| octolytics-dimension-user_login | python |
| octolytics-dimension-repository_id | 81598961 |
| octolytics-dimension-repository_nwo | python/cpython |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 81598961 |
| octolytics-dimension-repository_network_root_nwo | python/cpython |
| turbo-body-classes | logged-out env-production page-responsive full-width |
| disable-turbo | true |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | 82560a55c6b2054555076f46e683151ee28a19bc |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width