summaryrefslogtreecommitdiffstats
path: root/Doc/tools
Commit message (Collapse)AuthorAgeFilesLines
* [3.9] gh-92448: Update the documentation builder to render the GitHub issue. ↵Dong-hee Na2022-05-081-4/+5
| | | | (GH-92449). (GH-92458)
* [3.9] gh-91888: add a `:gh:` role to the documentation (GH-91889) (#91935)Ezio Melotti2022-04-261-0/+24
| | | | | | | | | | | | | | | | | | * gh-91888: Add a :gh: role to the documentation (GH-91889). * [3.9] gh-91888: add a `:gh:` role to the documentation (GH-91889) * 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>. (cherry picked from commit f7641a2ffec243e5f600028a84debe9028a9ee44) Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
* [3.9] Update Sphinx bpo role to use redirect URI. (#91891)Ezio Melotti2022-04-241-1/+1
| | | | | | | | * Update Sphinx bpo role to use redirect URI. (GH-32342) * [3.9] Update Sphinx bpo role to use redirect URI. (GH-32342). (cherry picked from commit 08cfe079503ffd19d8b7ab324f0fdb1c6b150ca8) Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
* Add redirects to Misc/NEWS bpo links (GH-91454) (GH-91536)Miss Islington (bot)2022-04-141-1/+2
| | | | | (cherry picked from commit 17dbb6bc10ca8a8b602335414c047294f00afcbe) Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
* [3.9] bpo-46769: Fix backticks in typing.rst to appease rstlint (GH-32375)Ken Jin2022-04-061-1/+1
| | | | | * Use double backticks to appease rstlint * Update susp-ignored.csv
* [3.9] bpo-46769: Improve documentation for `typing.TypeVar` (GH-31712) ↵Jelle Zijlstra2022-03-231-0/+1
| | | | | | | | | | | | | | | | | | | (GH-31941) (GH-32067) * [3.9] [3.10] bpo-46769: Improve documentation for `typing.TypeVar` (GH-31712) (GH-31941) * [3.10] bpo-46769: Improve documentation for `typing.TypeVar` (GH-31712) Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com> (cherry picked from commit 81b425d4dc43b60dd11a3e9abc5c84a4b8b384db) * Remove references to `reveal_type`, add new section on `self` types. (cherry picked from commit d5ed8a8258eaf7a241978b1b0aeb971108d0f7e0) Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> * remove unused susp allowlist Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
* bpo-46463: Fixes escape4chm.py script used when building the CHM ↵Miss Islington (bot)2022-01-211-4/+5
| | | | | | | documentation file (GH-30768) (cherry picked from commit 57d1855682dbeb9233ef3a531f9535c6442e9992) Co-authored-by: Steve Dower <steve.dower@python.org>
* bpo-46231: Remove invalid_* rules preceded by more tokens from the grammar ↵Miss Islington (bot)2022-01-191-2/+2
| | | | | | | | | docs (GH-30341) (GH-30392) (cherry picked from commit e09d94a140a5f6903017da9b6ac752ba041d69da) Co-authored-by: Pablo Galindo Salgado <Pablogsal@gmail.com> Co-authored-by: Pablo Galindo Salgado <Pablogsal@gmail.com>
* [3.9] bpo-46402: Promote SQLite URI tricks in sqlite3 docs (GH-30660) (#30672)Erlend Egeberg Aasland2022-01-181-1/+4
| | | | | | | | | | | | * bpo-46402: Promote SQLite URI tricks in `sqlite3` docs (GH-30660) Provide some examples of URI parameters in sqlite connect(). Co-authored-by: Ned Batchelder <ned@nedbatchelder.com> (cherry picked from commit bdf2ab1887a2edfb089a3c2a1590cf1e84ea0048) Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no> * Update suspicious rules
* bpo-41028: Doc: Move switchers to docsbuild-scripts. (GH-20969) (GH-30343)Miss Islington (bot)2022-01-024-171/+12
| | | | | | (cherry picked from commit ee2549c2ba8bae00f2b2fea8a39c6dfbd1d06520) Co-authored-by: Julien Palard <julien@palard.fr>
* [3.9] [doc] bpo-45680: Disambiguate ``__getitem__`` and ↵Miss Islington (bot)2021-11-181-0/+1
| | | | | | | | | | | | | | | | | ``__class_getitem__`` in the data model (GH-29389) (GH-29619) The documentation explaining Python's data model does not adequately explain the differences between ``__getitem__`` and ``__class_getitem__``, nor does it explain when each is called. There is an attempt at explaining ``__class_getitem__`` in the documentation for ``GenericAlias`` objects, but this does not give sufficient clarity into how the method works. Moreover, it is the wrong place for that information to be found; the explanation of ``__class_getitem__`` should be in the documentation explaining the data model. This PR has been split off from GH-29335. (cherry picked from commit 31b3a70edb1216bdc8fab3b2eafd8ddb00487f41) Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> Co-authored-by: Łukasz Langa <lukasz@langa.pl>
* docs: add the word 'official' (GH-26849)Miss Islington (bot)2021-07-081-1/+1
| | | | | (cherry picked from commit af4a2dcc40321de49bffec80bf6c6b5a7d43b134) Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
* bpo-44106: Improve sqlite3 example database contents (GH-26027)Miss Islington (bot)2021-05-191-2/+1
| | | | | (cherry picked from commit 92d1064727d6b7f4136f9c09ab52ae15e3676afe) Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no>
* bpo-32924: Fix the Show Source url in the documentation (GH-25994)Miss Islington (bot)2021-05-081-1/+1
| | | | | (cherry picked from commit 03acfc50ac0be8b49847b94dee93e21b1efa0e76) Co-authored-by: Pablo Galindo <Pablogsal@gmail.com>
* bpo-36384: Leading zeros in IPv4 addresses are no longer tolerated ↵Miss Islington (bot)2021-05-021-2/+2
| | | | | | | | | | | | (GH-25099) (GH-25815) Reverts commit e653d4d8e820a7a004ad399530af0135b45db27a and makes parsing even more strict. Like socket.inet_pton() any leading zero is now treated as invalid input. Signed-off-by: Christian Heimes <christian@python.org> Co-authored-by: Łukasz Langa <lukasz@langa.pl> (cherry picked from commit 60ce8f0be6354ad565393ab449d8de5d713f35bc)
* bpo-20364: Improve sqlite3 placeholder docs (GH-25003)Miss Islington (bot)2021-04-141-2/+2
| | | | | (cherry picked from commit 3386ca0b36327afeef8d7eff277b2aed1030c08d) Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no>
* Fixed linenumber missing when audit hook has an error (GH-24692)Miss Islington (bot)2021-03-011-0/+1
| | | | | | | | See https://github.com/sphinx-doc/sphinx/issues/8932 Co-authored-by: tk0miya <i.tkomiya@gmail.com> (cherry picked from commit dbfabcc0c306742e34b9b0e162c63ccebe9d2b05) Co-authored-by: Jules Lasne <jules.lasne@gmail.com>
* [3.9] Minor improvements to the convolve() recipe (GH-24520)Pablo Galindo2021-02-151-0/+1
|
* [3.9] bpo-42042: Use ids attribute instead of names attribute (GH-22739) ↵Dong-hee Na2020-11-131-2/+2
| | | | | | | (GH-23265) (cherry picked from commit 09490a109faaee9cc393b52742a8575c116c56ba) Co-authored-by: Dong-hee Na <donghee.na@python.org>
* Expand and clarify the "Invoking Descriptors" section of the Descriptor ↵Miss Skeleton (bot)2020-11-011-1/+1
| | | | HowTo (GH-23078) (GH-23080)
* bpo-42061: Document __format__ for IP addresses (GH-23018)Miss Skeleton (bot)2020-10-291-2/+4
| | | | | | Automerge-Triggered-By: GH:ericvsmith (cherry picked from commit 3317466061509c83dce257caab3661d52571cab1) Co-authored-by: Teugea Ioan-Teodor <teodor.teugea@gmail.com>
* Create a primer section for the descriptor howto guide (GH-22906) (GH0-22918)Miss Skeleton (bot)2020-10-231-0/+3
|
* [3.9] Remove 3.5 from Doc version switcher in master. (GH-22886) (#22888)larryhastings2020-10-222-2/+0
| | | (cherry picked from commit 283f9a253b4ff4df728558205629b3bb3af6e47f)
* Doc: Do not suggest `s[::-1]` for reversed order (GH-22457)Miss Skeleton (bot)2020-10-211-1/+0
| | | | | (cherry picked from commit fb2e94692e3a8eb66915575f4a122d56fe8999a0) Co-authored-by: Andre Delfino <adelfino@gmail.com>
* bpo-35293: Remove RemovedInSphinx40Warning (GH-22198)Miss Islington (bot)2020-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> (cherry picked from commit 6595cb0af4c51c0381c233b97884fe916a4ddd35) Co-authored-by: Dong-hee Na <donghee.na92@gmail.com>
* Fix invalid escape sequences in the peg_highlight Sphinx extension ↵Miss Islington (bot)2020-09-021-1/+1
| | | | | | | | | (GH-22047) (GH-22065) (cherry picked from commit 5a4a963a6c798fa9207a9998618a9c0ec3b6b6d7) Co-authored-by: Pablo Galindo <Pablogsal@gmail.com> Co-authored-by: Pablo Galindo <Pablogsal@gmail.com>
* [3.9] bpo-40939: Use the new grammar for the grammar specification ↵Guido van Rossum2020-07-271-0/+75
| | | | | | | | | documentation (GH-19969) (#21641) (We censor the heck out of actions and some other stuff using a custom "highlighter".) (cherry picked from commit 72cabb2aa636272e608285f5a6ba83b62be9be4e) Co-authored-by: Pablo Galindo <Pablogsal@gmail.com>
* Doc: fix import of asdl.py when called from outside Doc/. (GH-21529) (#21567)Miss Islington (bot)2020-07-201-1/+4
| | | | | (cherry picked from commit 7f03445d01d5ece41c2ceef7254002e08e8ab5a5) Co-authored-by: Julien Palard <julien@palard.fr>
* bpo-40798: Generate a different message for already removed elements (GH-20483)Miss Islington (bot)2020-05-302-2/+12
| | | | | (cherry picked from commit 735d902b363b759df9ff00e58bbf4f7e2bde78cd) Co-authored-by: Florian Dahlitz <f2dahlitz@freenet.de>
* [3.9] Doc: Python 3.10 in sidebar and version switcher. (GH-20209) (GH-20221)Miss Islington (bot)2020-05-192-2/+4
| | | | | | (cherry picked from commit 19e3e0026417caa92ffe21a67157363b45da9aa2) Co-authored-by: Julien Palard <julien@palard.fr>
* Python 3.9.0b1v3.9.0b1Łukasz Langa2020-05-181-1/+1
|
* bpo-40517: Implement syntax highlighting support for ASDL (GH-19967)Batuhan Taskaya2020-05-071-0/+51
|
* Revert "bpo-40517: Implement syntax highlighting support for ASDL (#19928)" ↵Raymond Hettinger2020-05-061-51/+0
| | | | | (#19950) This reverts commit d60040ba226bd2e3b6f58d074015aa2499dc1cb8.
* bpo-40517: Implement syntax highlighting support for ASDL (#19928)Batuhan Taskaya2020-05-061-0/+51
|
* Fix download.html (GH-18902)Inada Naoki2020-03-111-1/+1
| | | | | `<tt>` is not allowed. Co-authored-by: Kyle Stanley <aeros167@gmail.com>
* bpo-34822: Simplify AST for subscription. (GH-9605)Serhiy Storchaka2020-03-101-0/+2
| | | | | | | | | * Remove the slice type. * Make Slice a kind of the expr type instead of the slice type. * Replace ExtSlice(slices) with Tuple(slices, Load()). * Replace Index(value) with a value itself. All non-terminal nodes in AST for expressions are now of the expr type.
* bpo-34788: Add support for scoped IPv6 addresses (GH-13772)opavlyuk2020-02-261-0/+2
| | | Automerge-Triggered-By: @asvetlov
* Doc: Change Python 2 status to EOL. (GH-17885)Inada Naoki2020-01-071-1/+1
|
* Remove use of deprecated `array.fromstring` method (GH-17332)David Coles2019-11-261-1/+1
|
* bpo-38738: Fix formatting of True and False. (GH-17083)Serhiy Storchaka2019-11-121-2/+2
| | | | | | | | | * "Return true/false" is replaced with "Return ``True``/``False``" if the function actually returns a bool. * Fixed formatting of some True and False literals (now in monospace). * Replaced "True/False" with "true/false" if it can be not only bool. * Replaced some 1/0 with True/False if it corresponds the code. * "Returns <bool>" is replaced with "Return <bool>".
* bpo-38592 Add pt-br switcher to Python Docs website (GH-16924)Marco Rougeth2019-10-271-0/+1
| | | | * 📜🤖 Added by blurb_it.
* bpo-38557: Improve documentation for list and tuple C API. (GH-16925)Serhiy Storchaka2019-10-261-0/+1
|
* Update doc switcher list for 3.8.0 (GH-16809)Ned Deily2019-10-151-1/+1
|
* Doc: 3.8 is now stable. (GH-16790)Julien Palard2019-10-141-1/+1
|
* bpo-38294: Add list of no-longer-escaped chars to re.escape documentation. ↵Ricardo Bánffy2019-10-071-0/+1
| | | | | | | | | (GH-16442) Prior to 3.7, re.escape escaped many characters that don't have special meaning in Python, but that use to require escaping in other tools and languages. This commit aims to make it clear which characters were, but are no longer escaped.
* bpo-36675: Remove obsolete code. (GH-16024)Julien Palard2019-09-121-32/+0
| | | | Does no longer work since Sphinx moved the trim_doctest_flag option in the configuration.
* bpo-33187: Document ElementInclude (XInclude) support in ElementTree (GH-8861)Anjali Bansal2019-09-111-0/+3
|
* bpo-37504: Fix documentation build with texinfo builder (GH-14606)Dmitry Shachnev2019-09-101-0/+1
| | | | | | | | | In the table model used by docutils, the `cols` attribute of `tgroup` nodes is mandatory, see [1]. It is used in texinfo builder in [2]. [1]: https://www.oasis-open.org/specs/tm9901.htm#AEN348 [2]: https://github.com/sphinx-doc/sphinx/blob/v2.1.2/sphinx/writers/texinfo.py#L1129 * Doc: Add texinfo support to the Makefile
* bpo-38086: Sync importlib.metadata with importlib_metadata 0.21. (GH-15840)Jason R. Coombs2019-09-101-1/+1
| | | https://gitlab.com/python-devs/importlib_metadata/-/tags/0.21
* Doc: Fix PDF build (NoUri). (GH-15739)Julien Palard2019-09-091-4/+11
|