summaryrefslogtreecommitdiffstats
path: root/Doc/tools
Commit message (Collapse)AuthorAgeFilesLines
* [3.10] gh-92448: Update the documentation builder to render the GitHub issue ↵Dong-hee Na2022-05-081-4/+5
| | | | (GH-92449). (GH-92457)
* [3.10] gh-91888: add a :gh: role to the documentation (GH-91889) (#91934)Ezio Melotti2022-04-261-0/+24
| | | | | | | | | | | | | | | | | | * gh-91888: Add a :gh: role to the documentation (GH-91889). * [3.10] 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.10] Update Sphinx bpo role to use redirect URI. (#91890)Ezio Melotti2022-04-241-1/+1
| | | | | | | | | | * Update Sphinx bpo role to use redirect URI. (GH-32342) * [3.10] Update Sphinx bpo role to use redirect URI. (GH-32342). (cherry picked from commit 08cfe079503ffd19d8b7ab324f0fdb1c6b150ca8) Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com> * Fix whitespace.
* Add redirects to Misc/NEWS bpo links (GH-91454) (GH-91535)Miss Islington (bot)2022-04-141-1/+2
| | | | | (cherry picked from commit 17dbb6bc10ca8a8b602335414c047294f00afcbe) Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
* [3.10] bpo-46769: Fix backticks in typing.rst to appease rstlint (GH-32374)Ken Jin2022-04-061-1/+1
| | | | | * Use double backticks to appease rstlint * Update susp-ignored.csv
* [3.10] bpo-46769: Improve documentation for `typing.TypeVar` (GH-31712) ↵Alex Waygood2022-03-231-0/+1
| | | | | | | | | | (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
* 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>
* [3.10] bpo-46402: Promote SQLite URI tricks in sqlite3 docs (GH-30660) ↵Erlend Egeberg Aasland2022-01-181-1/+4
| | | | | | | | | | | | | | (GH-30671) * 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-46231: Remove invalid_* rules preceded by more tokens from the grammar ↵Miss Islington (bot)2022-01-041-2/+2
| | | | | | | docs (GH-30341) (cherry picked from commit e09d94a140a5f6903017da9b6ac752ba041d69da) Co-authored-by: Pablo Galindo Salgado <Pablogsal@gmail.com>
* [3.10] [doc] bpo-45680: Disambiguate ``__getitem__`` and ↵Miss Islington (bot)2021-11-181-0/+1
| | | | | | | | | | | | | | | | | ``__class_getitem__`` in the data model (GH-29389) (GH-29620) 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>
* [3.10] bo-45655: Add "relevant PEPs" section to typing documentation (GH-29302)Alex Waygood2021-10-291-4/+4
| | | | | | | | | | | The list of PEPs at the top of the documentation for the ``typing`` module has become too long to be readable. This PR proposes presenting this information in a more structured and readable way by adding a new "relevant PEPs" section to the ``typing`` docs. (cherry picked from commit 03db1bbfd2d3f5a343c293b2f0e09a1e962df7ea) Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> Co-authored-by: Łukasz Langa <lukasz@langa.pl>
* [3.10] [doc] Fix typos found using codespell (GH-28744) (GH-28758)Christian Clauss2021-10-061-1/+1
|
* bpo-39452: Rewrite and expand __main__.rst (GH-26883)Miss Islington (bot)2021-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> (cherry picked from commit 7cba23164cf82f6619db002cd30021b5dfb1f809) Co-authored-by: Jack DeVries <58614260+jdevries3133@users.noreply.github.com>
* Update susp-ignored.csv line numbersMiss Islington (bot)2021-08-231-0/+6
|
* Move susp-ignored locationsMiss Islington (bot)2021-08-221-4/+4
|
* 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-43795: PEP 652 user documentation (GH-25668) (GH-26034)Miss Islington (bot)2021-05-141-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 (cherry picked from commit b05955d6f5f149523b5855a335444b7c6324bdb7) Co-authored-by: Petr Viktorin <encukou@gmail.com> Co-authored-by: Petr Viktorin <encukou@gmail.com>
* bpo-32924: Fix the Show Source url in the documentation (GH-25994)Pablo Galindo2021-05-081-1/+1
|
* Update the SOURCE_URI in pyspecific.py to point to the new branch (GH-25978)Pablo Galindo2021-05-081-1/+1
|
* bpo-36384: Leading zeros in IPv4 addresses are no longer tolerated (GH-25099)Christian Heimes2021-05-021-2/+2
| | | | | | | | | 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>
* bpo-43766: Fix TypeGuard docs (#25660)Ken Jin2021-04-271-0/+4
|
* Fix type group capture in the PEG highlight tool (GH-25464)Pablo Galindo2021-04-171-2/+7
|
* bpo-43862: Enhance -W cmdline option documentation (GH-25439)Victor Stinner2021-04-161-1/+5
| | | | | The -W format is "action:message:category:module:lineno". Update also the Python manual page.
* bpo-20364: Improve sqlite3 placeholder docs (GH-25003)Erlend Egeberg Aasland2021-04-141-2/+2
|
* Fix Sphinx errors in the documentation and re-activate the suspicious check ↵Pablo Galindo2021-04-121-0/+1
| | | | | | | (GH-25368) The suspicious check is still executed as part of the release process and release managers have been lately fixing some actual errors that the suspicious target can find. For this reason, reactivate the suspicious until we decide what to do in a coordinated fashion.
* 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>
* Remove unused suspicious rule in the docsv3.10.0a6Pablo Galindo2021-03-011-1/+0
|
* bpo-42128: Structural Pattern Matching (PEP 634) (GH-22917)Brandt Bucher2021-02-261-0/+1
| | | | | Co-authored-by: Guido van Rossum <guido@python.org> Co-authored-by: Talin <viridia@gmail.com> Co-authored-by: Pablo Galindo <pablogsal@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.
* Fix 'make suspicious' for the itertools module (GH-24097)Pablo Galindo2021-01-041-0/+1
|
* bpo-34398: Allow glossary results to show up on search page (GH-8773)Ammar Askar2020-12-182-0/+105
|
* bpo-42238: Check Misc/NEWS.d/next/ for reStructuredText issues. (GH-23802)Julien Palard2020-12-181-0/+76
|
* 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-41028: Doc: Move switchers to docsbuild-scripts. (GH-20969)Julien Palard2020-11-074-171/+12
|
* Expand and clarify the "Invoking Descriptors" section of the Descriptor ↵Raymond Hettinger2020-11-011-1/+1
| | | | HowTo (GH-23078)
* bpo-42061: Document __format__ for IP addresses (GH-23018)Teugea Ioan-Teodor2020-10-291-2/+4
| | | Automerge-Triggered-By: GH:ericvsmith
* Create a primer section for the descriptor howto guide (GH-22906)Raymond Hettinger2020-10-231-0/+3
|
* Remove 3.5 from Doc version switcher in master. (#22886)larryhastings2020-10-222-2/+0
|
* Doc: Do not suggest `s[::-1]` for reversed order (GH-22457)Andre Delfino2020-10-211-1/+0
|
* bpo-4356: Add key function support to the bisect module (GH-20556)Raymond Hettinger2020-10-201-2/+0
|
* 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-302-2/+12
|
generated by cgit v0.12 at 2026-01-04 06:16:39 (GMT)