summaryrefslogtreecommitdiffstats
path: root/Doc/tools/extensions
Commit message (Collapse)AuthorAgeFilesLines
* [3.11] Docs: Link tokens in the format string grammars (GH-108184) (#113840)Miss Islington (bot)2024-01-091-0/+5
| | | | | | | | Docs: Link tokens in the format string grammars (GH-108184) (cherry picked from commit f3d5d4aa8f0388217aeff69e28d078bdda464b38) Co-authored-by: William Andrea <william.j.andrea@gmail.com> Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com> Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com>
* [3.11] gh-113637: Let c_annotations.py to handle the spacing of ↵Ege Akman2024-01-031-5/+6
| | | | Limited/Unstable API & Stable ABI translation strings (#113638) (#113679)
* [3.11] GH-101986: Support translation for Limited/Unstable API & Stable ABI ↵Hugo van Kemenade2023-12-101-7/+7
| | | | | | | (GH-107680) (#112941) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
* [3.11] Clarify how topics.py gets created. (GH-106121) (GH-106580)Miss Islington (bot)2023-08-221-0/+1
| | | | | | | | | | | | When changing docs, it was easy to find text in topics.py, and I wondered whether I was supposed to edit it. Thankfully, the top of the file says it's auto-generated, so I knew I didn't have to edit it. But I didn't know what started the auto-generation process. It's part of the release process, so I'll leave a note here for future editors. (cherry picked from commit dac1e364901d3668742e6eecc2ce63586330c11f) Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
* [3.11] GH-84435: Make pyspecific directives translatable (GH-19470) (#107682)Miss Islington (bot)2023-08-081-10/+8
| | | | | | | | GH-84435: Make pyspecific directives translatable (GH-19470) (cherry picked from commit ecb05e0b9842ba03b42b4dec8767b1c18a4e28b3) Co-authored-by: cocoatomo <cocoatomo77@gmail.com> Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com> Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
* [3.11] Do not use deprecated ``logger.warn()`` in pyspecific (GH-107694) ↵Miss Islington (bot)2023-08-061-3/+3
| | | | | | | | (#107696) Do not use deprecated ``logger.warn()`` in pyspecific (GH-107694) (cherry picked from commit 9564e31cbc95a723f2414537231bc4611b56644f) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* [3.11] Docs: Avoid a DeprecationWarning in `pyspecific.py` when running with ↵Miss Islington (bot)2023-06-231-11/+9
| | | | | | | | | Sphinx >=6.1 (GH-105886) (#106011) Docs: Avoid a DeprecationWarning in `pyspecific.py` when running with Sphinx >=6.1 (GH-105886) (cherry picked from commit a72683ba8e0337650cc490dbe593a5e46aba60cb) Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
* [3.11] GH-104284: Fix documentation gettext build (GH-104296) (#104299)Miss Islington (bot)2023-05-081-10/+10
| | | | Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* [3.11] GH-97950: Use new-style index directive ('builtin') (GH-104164) (#104221)Miss Islington (bot)2023-05-061-1/+1
| | | | | | | | | | | | | | | | | | GH-97950: Use new-style index directive ('builtin') (GH-104164) * Uncomment builtin removal in pairindextypes * Use new-style index directive ('builtin') - C API * Use new-style index directive ('builtin') - Extending * Use new-style index directive ('builtin') - Library * Use new-style index directive ('builtin') - Reference * Use new-style index directive ('builtin') - Tutorial (cherry picked from commit f5088006ca8e9654fbc3de119462f0ab764e408b) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* [3.11] GH-97950: Use new-style index directive ('statement') (GH-104162) ↵Miss Islington (bot)2023-05-041-1/+1
| | | | | | (#104163) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* [3.11] GH-97950: Use new-style index directive ('exception') (GH-104160) ↵Adam Turner2023-05-041-1/+1
| | | | (#104161)
* [3.11] GH-97950: Use new-style index directive ('object') (GH-104158) (#104159)Miss Islington (bot)2023-05-041-1/+1
| | | | | | | | | | | | | | | | GH-97950: Use new-style index directive ('object') (GH-104158) * Uncomment object removal in pairindextypes * Use new-style index directive ('object') - C API * Use new-style index directive ('object') - Library * Use new-style index directive ('object') - Reference * Use new-style index directive ('object') - Tutorial (cherry picked from commit 6ab463684b9d79880d98cd1f1406aa86af65985e) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* [3.11] GH-97950: Use new-style index directive ('operator') (GH-104156) ↵Miss Islington (bot)2023-05-041-1/+1
| | | | | | (#104157) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* [3.11] GH-97950: Use new-style index directive ('keyword') (GH-104153) (#104155)Miss Islington (bot)2023-05-041-1/+1
| | | | | | | | | | GH-97950: Use new-style index directive ('keyword') (GH-104153) * Uncomment keyword removal in pairindextypes * Use new-style index directive ('keyword') - Reference (cherry picked from commit 33ca322c50baa5152afe388fb3b8b7d63dc5a9b9) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* [3.11] GH-97950: Use new-style index directive ('module') (GH-103996) (#104154)Adam Turner2023-05-041-5/+1
|
* [3.11] GH-97950: Allow translation of index directive content (GH-104000) ↵Miss Islington (bot)2023-05-041-0/+29
| | | | | | (#104151) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* Docs: use Node.findall to avoid a deprecation warning (GH-99403)Miss Islington (bot)2023-04-081-1/+12
| | | | | (cherry picked from commit 1e9dfdacefa2c8c27762ba6491b0f570147ee355) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* Add gettext support to tools/extensions/c_annotations.py (GH-101989)Miss Islington (bot)2023-03-061-3/+4
| | | | | (cherry picked from commit d959bcd4a0393a120fa12c034de4041037d171c3) Co-authored-by: Rémi Lapeyre <remi.lapeyre@lenstra.fr>
* gh-101845: pyspecific: Fix i18n for availability directive (GH-101846)Miss Islington (bot)2023-02-121-9/+11
| | | | | | | | | | | | | pyspecific: Fix i18n for availability directive If the directive has content, the previous code would nest paragraph nodes from that content inside a general paragraph node, which confuses Sphinx and leads it to drop the content when translating. Instead, use a container node for the body. Also use set_source_info so that any warnings have location info. (cherry picked from commit 6ef6915d3530e844243893f91bf4bd702dfef570) Co-authored-by: Jean Abou-Samra <jean@abou-samra.fr>
* gh-98366: use sphinx.locale._ as gettext() in pyspecific.py (GH-98437)Miss Islington (bot)2022-11-111-4/+4
| | | | | | | | fix(doc-tools): use sphinx.locale._ as gettext() for backward-compatibility in pyspecific.py [why] spinix 5.3 changed locale.translators from a defaultdict(gettext.NullTranslations) to a dict, which leads to failure of pyspecific.py. Use sphinx.locale._ as gettext to fix the issue. (cherry picked from commit d26ee8a0a552de111b8245ef0de63e3f3f535d9f) Co-authored-by: Wei-Hsiang (Matt) Wang <mattwang44@gmail.com>
* gh-97607: Fix content parsing in the impl-detail reST directive (GH-97652)Miss Islington (bot)2022-10-021-16/+7
| | | | | | | | | | | | | | | | | | | | | | * Don't parse content as arg in the impl-detail directive This does not change the (untranslated) output, but ensures that the doctree node metadata is correct. which fixes gh-97607 with the text not being translated. It also simplifies the code and logic and makes it consistant with the docutils built-in directives. * Remove unused branch from impl-detail directive handling no-content case This is not used anywhere in the docs and lacks a clear use case, and is more likely a mistake which is now flagged at build time. This simplifies the logic from two code paths to one, and makes the behavior consistant with similar built-in directives (e.g. the various admonition types). * Further simplify impl-detail reST directive code (cherry picked from commit e8165d47b852e933c176209ddc0b5836a9b0d5f4) Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
* gh-95451: Update docs for wasm32-emscripten and -wasi platforms (GH-95452)Miss Islington (bot)2022-08-021-8/+6
| | | | | | | | | Co-authored-by: Éric <merwok@netwok.org> Co-authored-by: Michael Droettboom <mdboom@gmail.com> Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com> Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM> (cherry picked from commit e3b6ff19aaa318a813130ba9ad2ab0a332f27feb) Co-authored-by: Christian Heimes <christian@python.org>
* [3.11] gh-95415: Make availability directive consistent (GH-95416) (GH-95438)Christian Heimes2022-08-011-1/+57
| | | Co-authored-by: Christian Heimes <christian@python.org>
* gh-86986: Drop compatibility support for Sphinx 2 (GH-93737)Miss Islington (bot)2022-06-212-40/+8
| | | | | | | | | | | | * Revert "bpo-42843: Keep Sphinx 1.8 and Sphinx 2 compatibility (GH-24282)" This reverts commit 5c1f15b4b1024cbf0acc85832f0c623d1a4605fd * Revert "bpo-42579: Make workaround for various versions of Sphinx more robust (GH-23662)" This reverts commit b63a620014b67a6e63d10783149c41baaf59def8. (cherry picked from commit 0efe3a1636c143fe0694a8e4d25d6eae19e0d618) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* gh-92448: Update the documentation builder to render the GitHub issue. ↵Miss Islington (bot)2022-05-081-4/+5
| | | | | | | (GH-92449) (cherry picked from commit 45e1721d100bab09510ccf9da49f14ca5cc268f4) Co-authored-by: Dong-hee Na <donghee.na@python.org>
* Update the SOURCE_URI in pyspecific.py to point to the new branchv3.11.0b1Pablo Galindo2022-05-061-1/+1
|
* gh-91888: add a `:gh:` role to the documentation (#91889)Ezio Melotti2022-04-251-0/+24
| | | | | | | | | | | * Add a new :gh:`...` role for GitHub issues. * Fix a GitHub id to use the :gh: role. * Add Misc/NEWS entry. * Refactoring and rephrasing. Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
* Add redirects to Misc/NEWS bpo links (#91454)Ezio Melotti2022-04-141-1/+2
|
* Update Sphinx bpo role to use redirect URI. (#32342)Ezio Melotti2022-04-111-1/+1
|
* bpo-47115: Document which parts of structs are in limited API/stable ABI ↵Petr Viktorin2022-04-061-3/+22
| | | | | | (GH-32196) Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no>
* bpo-46463: Fixes escape4chm.py script used when building the CHM ↵Steve Dower2022-01-211-4/+5
| | | | documentation file (GH-30768)
* bpo-46231: Remove invalid_* rules preceded by more tokens from the grammar ↵Pablo Galindo Salgado2022-01-041-2/+2
| | | | docs (GH-30341)
* bpo-42238: [doc] remove unused, and deduplicate, suspicious ignore rules. ↵Julien Palard2021-09-061-1/+1
| | | | (GH-28137)
* bpo-43795: PEP 652 user documentation (GH-25668)Petr Viktorin2021-05-111-22/+88
| | | | | | - Reformat the C API and ABI Versioning page (and extend/clarify a bit) - Rewrite the stable ABI docs into a general text on C API Compatibility - Add a list of Limited API contents, and notes for the individual items. - Replace `Include/README.rst` with a link to a devguide page with the same info
* Update the SOURCE_URI in pyspecific.py to point to the new branch (GH-25977)Pablo Galindo2021-05-081-1/+1
|
* Fix type group capture in the PEG highlight tool (GH-25464)Pablo Galindo2021-04-171-2/+7
|
* bpo-43778: Fix Sphinx glossary_search extension (GH-25286)Victor Stinner2021-04-081-5/+11
| | | | | Create the _static/ directory if it doesn't exist. Add also constants for the static directory and the JSON filename.
* Fixed linenumber missing when audit hook has an error (GH-24692)Jules Lasne2021-03-011-0/+1
| | | | | See https://github.com/sphinx-doc/sphinx/issues/8932 Co-authored-by: tk0miya <i.tkomiya@gmail.com>
* bpo-42997: Improve error message for missing : before suites (GH-24292)Pablo Galindo2021-02-021-0/+6
| | | | | | | | * Add to the peg generator a new directive ('&&') that allows to expect a token and hard fail the parsing if the token is not found. This allows to quickly emmit syntax errors for missing tokens. * Use the new grammar element to hard-fail if the ':' is missing before suites.
* bpo-34398: Allow glossary results to show up on search page (GH-8773)Ammar Askar2020-12-181-0/+57
|
* bpo-42579: Make workaround for various versions of Sphinx more robust (GH-23662)Matěj Cepl2020-12-071-1/+6
| | | | | | The solution in gh#python/cpython#13236 is too strict because it effectively requires the use of Sphinx >= 2.0. It is not too difficult to make the same solution more robust so it works with all normal versions of Sphinx.
* bpo-42042: Use ids attribute instead of names attribute (GH-22739)Dong-hee Na2020-11-131-2/+2
|
* bpo-35293: Remove RemovedInSphinx40Warning (GH-22198)Dong-hee Na2020-09-181-15/+21
| | | | | | | | | | | * bpo-35293: Remove RemovedInSphinx40Warning * Update Misc/NEWS.d/next/Documentation/2020-09-12-17-37-13.bpo-35293._cOwPD.rst Co-authored-by: Victor Stinner <vstinner@python.org> * bpo-35293: Apply Victor's review Co-authored-by: Victor Stinner <vstinner@python.org>
* bpo-41746: Add type information to asdl_seq objects (GH-22223)Pablo Galindo2020-09-161-1/+1
| | | | | | | | | | | | | * Add new capability to the PEG parser to type variable assignments. For instance: ``` | a[asdl_stmt_seq*]=';'.small_stmt+ [';'] NEWLINE { a } ``` * Add new sequence types from the asdl definition (automatically generated) * Make `asdl_seq` type a generic aliasing pointer type. * Create a new `asdl_generic_seq` for the generic case using `void*`. * The old `asdl_seq_GET`/`ast_seq_SET` macros now are typed. * New `asdl_seq_GET_UNTYPED`/`ast_seq_SET_UNTYPED` macros for dealing with generic sequences. * Changes all possible `asdl_seq` types to use specific versions everywhere.
* Fix invalid escape sequences in the peg_highlight Sphinx extension (GH-22047)Pablo Galindo2020-09-021-1/+1
|
* bpo-40939: Use the new grammar for the grammar specification documentation ↵Pablo Galindo2020-07-271-0/+75
| | | | | | | (GH-19969) (We censor the heck out of actions and some other stuff using a custom "highlighter".) Co-authored-by: Guido van Rossum <guido@python.org>
* Doc: fix import of asdl.py when called from outside Doc/. (GH-21529)Julien Palard2020-07-201-1/+4
|
* bpo-40742: Doc: fix parallel build. (GH-21237)Julien Palard2020-07-061-0/+35
|
* bpo-40798: Generate a different message for already removed elements (GH-20483)Florian Dahlitz2020-05-301-2/+11
|
* bpo-40517: Implement syntax highlighting support for ASDL (GH-19967)Batuhan Taskaya2020-05-071-0/+51
|