summaryrefslogtreecommitdiffstats
path: root/Doc/tools
Commit message (Collapse)AuthorAgeFilesLines
* [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>
* [3.11] Replace Netlify with Read the Docs build previews (#103843) (#104083)Hugo van Kemenade2023-05-021-0/+8
| | | | | Co-authored-by: Oleg Iarygin <dralife@yandex.ru> Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
* 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-062-3/+9
| | | | | (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>
* [3.11] Docs: Fix the Show Source link (GH-100733)Zachary Ware2023-01-031-1/+1
| | | See also python/release-tools#10
* 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>
* [3.11] gh-93675: Fix typos in `Doc/` (GH-93676) (GH-94079)Łukasz Langa2022-06-211-1/+1
| | | | | | Closes GH-93675 (cherry picked from commit 830513754d081619b2d72db17770627312072fa5) Co-authored-by: luzpaz <luzpaz@users.noreply.github.com>
* gh-93851: Fix all broken links in Doc/ (GH-93853) (GH-94076)Miss Islington (bot)2022-06-211-0/+4
| | | | | (cherry picked from commit f62ff97f31a775cc7956adeae32c14e7c85bdc15) Co-authored-by: Oleg Iarygin <oleg@arhadthedev.net>
* 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-86404: [doc] A make sucpicious false positive. (GH-93710)Miss Islington (bot)2022-06-111-0/+2
| | | | | (cherry picked from commit bc3b31ea776ecb7088c8c2acd121499be8e8638b) Co-authored-by: Julien Palard <julien@palard.fr>
* 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-42238: [doc]: A make sucpicious false positive. (GH-32329)Julien Palard2022-04-051-0/+1
|
* bpo-42238: [doc]: make suspicious: false positive. (GH-32292)Julien Palard2022-04-031-0/+1
|
* bpo-47126: Update to canonical PEP URLs specified by PEP 676 (GH-32124)Hugo van Kemenade2022-03-301-1/+1
|
* bpo-47086: Remove dead link to old CHM documentation (GH-32075)Steve Dower2022-03-231-4/+0
|
* bpo-42238: [doc] Some lines moved in rst, but had hardcoded lineno in ↵Julien Palard2022-03-231-6/+6
| | | | susp-ignored.csv. (GH-32070)
* [doc] Some more make suspicious false positives. (GH-31977)Julien Palard2022-03-181-0/+2
|
* bpo-42238: [doc] moving from rstlint.py to sphinx-lint. (GH-31097)Julien Palard2022-02-101-0/+5
|
* bpo-42238: [doc] Avoid hardcoding fast-moving lines in susp-ignored.csv. ↵Julien Palard2022-01-281-2/+2
| | | | (GH-30981)
* [doc]: Spotted errors while working on rstlint. (GH-30879)Julien Palard2022-01-271-3/+12
| | | | Also ignored some `make suspicious` false positives while assuring true positives were properly seen by rstlint.
* 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)
* Fix some false positives of documentation syntax problemsPablo Galindo2021-12-081-2/+2
|
* bpo-42238: [doc]: Hide false positive in make suspicious. (GH-29636)Julien Palard2021-11-191-0/+1
|
* [doc]: Fix missing space in c-api/init.rst and add rstlint rule (GH-28988)Julien Palard2021-10-191-5/+12
|
* [doc]: update susp-ignored.csv after a98b273c. (GH-28827)Julien Palard2021-10-091-2/+2
|
* [doc] Fix typos found using codespell (GH-28744)Christian Clauss2021-10-051-1/+1
| | | Co-authored-by: Łukasz Langa <lukasz@langa.pl>
* bpo-42238: [doc] remove unused, and deduplicate, suspicious ignore rules. ↵Julien Palard2021-09-062-21/+11
| | | | (GH-28137)
* bpo-42238: [doc] Some more make suspicious false positives. (GH-27945)Julien Palard2021-08-261-0/+10
|
* bpo-39452: Rewrite and expand __main__.rst (#26883)Jack DeVries2021-08-241-0/+1
| | | | | | | Broadened scope of the document to explicitly discuss and differentiate between ``__main__.py`` in packages versus the ``__name__ == '__main__'`` expression (and the idioms that surround it), as well as ``import __main__``. Co-authored-by: Géry Ogam <gery.ogam@gmail.com> Co-authored-by: Éric Araujo <merwok@netwok.org> Co-authored-by: Łukasz Langa <lukasz@langa.pl>
* bpo-42560: rewrite of Tkinter docs "life preserver" (GH-27842)Mark Roseman2021-08-231-0/+6
| | | Co-authored-by: Łukasz Langa <lukasz@langa.pl>
* bpo-44854: Remove trailing whitespaces (GH-27689)Serhiy Storchaka2021-08-091-2/+2
|
* bpo-42238: Fix small rst issue in NEWS.d/. (#27238)Julien Palard2021-07-191-1/+9
|