summaryrefslogtreecommitdiffstats
path: root/Doc/tools
Commit message (Collapse)AuthorAgeFilesLines
* gh-98040: Remove just the `imp` module (#98573)Barry Warsaw2023-04-281-1/+0
|
* gh-103765: Remove pkgutil.rst from .nitignore (GH-103797)Jaime Alonso Lorenzo2023-04-241-1/+0
|
* gh-103810: Fix broken references in dataclasses (#103811)Olga Matoula2023-04-241-1/+0
| | | Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
* gh-101100: Fix Sphinx warnings in `argparse` module (#103289)Hugo van Kemenade2023-04-241-2/+0
| | | | | Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM> Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
* Docs: use Node.findall to avoid a deprecation warning (#99403)Adam Turner2023-04-081-1/+12
|
* gh-101100: Use list of 'dirty' docs, with warnings, instead of a clean list ↵Hugo van Kemenade2023-04-033-371/+332
| | | | | | (#103191) Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
* gh-101100: Expand list of clean docs (GH-103135)Hugo van Kemenade2023-03-312-0/+357
| | | | | | | | | | | Follow on from https://github.com/python/cpython/pull/103116. Expand list of clean docs files from 3 to 181. These files have no Sphinx warnings, and their presence in this list means that any new warnings introduced will fail the build. The list was created by subtracting the list of files with warnings from a list of all files. I tested with all of those, but found that `touch`ing two clean files (https://github.com/python/cpython/blob/main/Doc/includes/wasm-notavail.rst and https://github.com/python/cpython/blob/main/Doc/whatsnew/changelog.rst) caused a cascade effect and resulted in a number of dirty files being rebuilt too, and failing the build. So those two have been omitted. Automerge-Triggered-By: GH:hugovk
* gh-101100: Fix Sphinx warning in gc.rst and refactor docs clean list (#103116)Hugo van Kemenade2023-03-302-0/+30
| | | | Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
* gh-101100: Test docs in nit-picky mode (#102513)Hugo van Kemenade2023-03-241-0/+25
| | | | | Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM> Co-authored-by: Petr Viktorin <encukou@gmail.com>
* Add gettext support to tools/extensions/c_annotations.py (#101989)Rémi Lapeyre2023-03-062-3/+9
|
* gh-101101: Unstable C API tier (PEP 689) (GH-101102)Petr Viktorin2023-02-281-0/+16
|
* gh-101845: pyspecific: Fix i18n for availability directive (GH-101846)Jean Abou-Samra2023-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.
* bpo-37860: re-add netlify.toml to set up deploy previews for docs (#92852)Ashwin Ramaswami2022-12-061-0/+13
| | | | | | | | | | | | | | | | | | | | | | | | | * Revert "bpo-46184: remove `netlify.toml` (#30272)" This reverts commit fbaf2e604cd354f1ebc6be029480010c6715a8ca. * Delete runtime.txt * Create runtime.txt * Delete runtime.txt * Update netlify.toml * Update netlify.toml * Add netlify badge * Update Doc/tools/templates/layout.html Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com> * Update layout.html Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
* gh-98366: use sphinx.locale._ as gettext() in pyspecific.py (#98437)Wei-Hsiang (Matt) Wang2022-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.
* gh-86404: Doc: Drop now unused make suspicious and rstlint. (GH-98179)Julien Palard2022-10-114-1064/+0
| | | | They have been replaced by [sphinx-lint](https://github.com/sphinx-contrib/sphinx-lint).
* gh-97607: Fix content parsing in the impl-detail reST directive (#97652)C.A.M. Gerlach2022-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
* gh-95451: Update docs for wasm32-emscripten and -wasi platforms (GH-95452)Christian Heimes2022-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>
* gh-95415: Make availability directive consistent (GH-95416)Christian Heimes2022-07-291-1/+57
|
* gh-86404: [doc] Two 'make suspicious' false positives. (GH-94407)Julien Palard2022-06-291-0/+2
|
* gh-84623: Remove unused imports (#94132)Victor Stinner2022-06-223-4/+2
|
* gh-93675: Fix typos in `Doc/` (GH-93676)luzpaz2022-06-211-1/+1
| | | Closes #93675
* gh-93851: Fix all broken links in Doc/ (GH-93853)Oleg Iarygin2022-06-211-0/+4
|
* gh-86986: Drop compatibility support for Sphinx 2 (GH-93737)Adam Turner2022-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.
* gh-86404: [doc] A make sucpicious false positive. (GH-93710)Julien Palard2022-06-111-0/+2
|
* gh-92448: Update the documentation builder to render the GitHub issue. ↵Dong-hee Na2022-05-081-4/+5
| | | | (GH-92449)
* Update the SOURCE_URI in pyspecific.py to point to the new branchPablo Galindo2022-05-081-1/+1
|
* 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>