Commit Graph

1032 Commits

Author SHA1 Message Date
Łukasz Langa 38fdff9274
[3.10] gh-93851: Fix all broken links in Doc/ (GH-93853) (GH-94078)
(cherry picked from commit f62ff97f31)

Co-authored-by: Oleg Iarygin <oleg@arhadthedev.net>
2022-06-21 21:37:09 +02:00
Miss Islington (bot) 223fde359a
gh-86986: Drop compatibility support for Sphinx 2 (GH-93737)
* Revert "bpo-42843: Keep Sphinx 1.8 and Sphinx 2 compatibility (GH-24282)"

This reverts commit 5c1f15b4b1

* Revert "bpo-42579: Make workaround for various versions of Sphinx more robust (GH-23662)"

This reverts commit b63a620014.
(cherry picked from commit 0efe3a1636)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2022-06-21 10:51:23 -07:00
Miss Islington (bot) a2695be91c
[3.10] Improve logging documentation with example and additional cookbook re… (GH-93644) (GH-93648)
(cherry picked from commit e974b3e333)

Co-authored-by: Vinay Sajip <vinay_sajip@yahoo.co.uk>
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
2022-06-10 16:31:00 +02:00
Dong-hee Na 731d893bdf
[3.10] gh-92448: Update the documentation builder to render the GitHub issue (GH-92449). (GH-92457) 2022-05-08 22:31:40 +09:00
Ezio Melotti 4120bbae49
[3.10] gh-91888: add a :gh: role to the documentation (GH-91889) (#91934)
* 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 f7641a2ffe)

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
2022-04-26 02:51:28 +02:00
Ezio Melotti dc31334ab1
[3.10] Update Sphinx bpo role to use redirect URI. (#91890)
* 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 08cfe07950)

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>

* Fix whitespace.
2022-04-24 23:07:51 +02:00
Miss Islington (bot) 35fef27110
Add redirects to Misc/NEWS bpo links (GH-91454) (GH-91535)
(cherry picked from commit 17dbb6bc10)

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
2022-04-14 17:02:03 +02:00
Ken Jin 80af26d25a
[3.10] bpo-46769: Fix backticks in typing.rst to appease rstlint (GH-32374)
* Use double backticks to appease rstlint

* Update susp-ignored.csv
2022-04-07 02:00:26 +08:00
Alex Waygood d5ed8a8258
[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 81b425d4dc)

* Remove references to `reveal_type`, add new section on `self` types
2022-03-22 19:52:40 -07:00
Miss Islington (bot) d548c87171
bpo-46463: Fixes escape4chm.py script used when building the CHM documentation file (GH-30768)
(cherry picked from commit 57d1855682)

Co-authored-by: Steve Dower <steve.dower@python.org>
2022-01-21 14:11:47 -08:00
Erlend Egeberg Aasland 01e6cbefd3
[3.10] bpo-46402: Promote SQLite URI tricks in sqlite3 docs (GH-30660) (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 bdf2ab1887)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no>

* Update suspicious rules
2022-01-18 16:57:33 -05:00
Miss Islington (bot) 743394f281
bpo-46231: Remove invalid_* rules preceded by more tokens from the grammar docs (GH-30341)
(cherry picked from commit e09d94a140)

Co-authored-by: Pablo Galindo Salgado <Pablogsal@gmail.com>
2022-01-04 03:03:46 -08:00
Miss Islington (bot) fde9f61e70
[3.10] [doc] bpo-45680: Disambiguate ``__getitem__`` and ``__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 31b3a70edb)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
2021-11-18 18:34:08 +01:00
Alex Waygood 2c8a0027e5
[3.10] bo-45655: Add "relevant PEPs" section to typing documentation (GH-29302)
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 03db1bbfd2)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
2021-10-29 18:03:48 +08:00
Christian Clauss d15f47d179
[3.10] [doc] Fix typos found using codespell (GH-28744) (GH-28758) 2021-10-06 15:56:57 +02:00
Miss Islington (bot) ec5a03168f
bpo-39452: Rewrite and expand __main__.rst (GH-26883)
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 7cba23164c)

Co-authored-by: Jack DeVries <58614260+jdevries3133@users.noreply.github.com>
2021-08-24 13:54:08 -07:00
Miss Islington (bot) 4673dc26f8
Update susp-ignored.csv line numbers 2021-08-23 15:52:02 -07:00
Miss Islington (bot) 57b321c377
Move susp-ignored locations 2021-08-22 13:04:43 -07:00
Miss Islington (bot) a219d6bc8f
docs: add the word 'official' (GH-26849)
(cherry picked from commit af4a2dcc40)

Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
2021-07-08 10:27:57 -05:00
Miss Islington (bot) 3185bc9d3f
bpo-44106: Improve sqlite3 example database contents (GH-26027)
(cherry picked from commit 92d1064727)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no>
2021-05-19 10:44:00 +03:00
Miss Islington (bot) 373937182e
bpo-43795: PEP 652 user documentation (GH-25668) (GH-26034)
- 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 b05955d6f5)

Co-authored-by: Petr Viktorin <encukou@gmail.com>

Co-authored-by: Petr Viktorin <encukou@gmail.com>
2021-05-13 22:29:09 -07:00
Pablo Galindo 03acfc50ac
bpo-32924: Fix the Show Source url in the documentation (GH-25994) 2021-05-08 17:15:01 +01:00
Pablo Galindo f46ef57c25
Update the SOURCE_URI in pyspecific.py to point to the new branch (GH-25978) 2021-05-08 03:43:43 +01:00
Christian Heimes 60ce8f0be6
bpo-36384: Leading zeros in IPv4 addresses are no longer tolerated (GH-25099)
Reverts commit e653d4d8e8 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>
2021-05-02 14:00:35 +02:00
Ken Jin 99fdd78200
bpo-43766: Fix TypeGuard docs (#25660) 2021-04-27 08:55:08 -07:00
Pablo Galindo f5c5c0c362
Fix type group capture in the PEG highlight tool (GH-25464) 2021-04-18 00:18:13 +01:00
Victor Stinner 62ec638648
bpo-43862: Enhance -W cmdline option documentation (GH-25439)
The -W format is "action:message:category:module:lineno".

Update also the Python manual page.
2021-04-16 19:12:14 +02:00
Erlend Egeberg Aasland 3386ca0b36
bpo-20364: Improve sqlite3 placeholder docs (GH-25003) 2021-04-14 15:28:55 +03:00
Pablo Galindo 20ac34772a
Fix Sphinx errors in the documentation and re-activate the suspicious check (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.
2021-04-12 20:53:15 +01:00
Victor Stinner f32d022147
bpo-43778: Fix Sphinx glossary_search extension (GH-25286)
Create the _static/ directory if it doesn't exist.

Add also constants for the static directory and the JSON filename.
2021-04-09 00:07:01 +02:00
Jules Lasne dbfabcc0c3
Fixed linenumber missing when audit hook has an error (GH-24692)
See https://github.com/sphinx-doc/sphinx/issues/8932

Co-authored-by: tk0miya <i.tkomiya@gmail.com>
2021-03-01 22:59:58 +01:00
Pablo Galindo cc12888f9b
Remove unused suspicious rule in the docs 2021-03-01 16:48:59 +00:00
Brandt Bucher 145bf269df
bpo-42128: Structural Pattern Matching (PEP 634) (GH-22917)
Co-authored-by: Guido van Rossum <guido@python.org>
Co-authored-by: Talin <viridia@gmail.com>
Co-authored-by: Pablo Galindo <pablogsal@gmail.com>
2021-02-26 14:51:55 -08:00
Pablo Galindo 58fb156edd
bpo-42997: Improve error message for missing : before suites (GH-24292)
* 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.
2021-02-02 19:54:22 +00:00
Pablo Galindo de833b6013
Fix 'make suspicious' for the itertools module (GH-24097) 2021-01-04 17:24:22 +00:00
Ammar Askar 8c5d0347ef
bpo-34398: Allow glossary results to show up on search page (GH-8773) 2020-12-18 20:00:51 +01:00
Julien Palard b9735420aa
bpo-42238: Check Misc/NEWS.d/next/ for reStructuredText issues. (GH-23802) 2020-12-18 10:48:08 +01:00
Matěj Cepl b63a620014
bpo-42579: Make workaround for various versions of Sphinx more robust (GH-23662)
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.
2020-12-07 20:05:13 +00:00
Dong-hee Na 09490a109f
bpo-42042: Use ids attribute instead of names attribute (GH-22739) 2020-11-14 00:15:17 +09:00
Julien Palard ee2549c2ba
bpo-41028: Doc: Move switchers to docsbuild-scripts. (GH-20969) 2020-11-07 12:28:31 +01:00
Raymond Hettinger 148c76b27c
Expand and clarify the "Invoking Descriptors" section of the Descriptor HowTo (GH-23078) 2020-11-01 09:10:06 -08:00
Teugea Ioan-Teodor 3317466061
bpo-42061: Document __format__ for IP addresses (GH-23018)
Automerge-Triggered-By: GH:ericvsmith
2020-10-29 15:17:59 -07:00
Raymond Hettinger 8d3d7314d4
Create a primer section for the descriptor howto guide (GH-22906) 2020-10-23 12:55:39 -07:00
larryhastings 283f9a253b
Remove 3.5 from Doc version switcher in master. (#22886) 2020-10-22 06:16:21 -07:00
Andre Delfino fb2e94692e
Doc: Do not suggest `s[::-1]` for reversed order (GH-22457) 2020-10-21 17:25:07 +09:00
Raymond Hettinger 871934d4cf
bpo-4356: Add key function support to the bisect module (GH-20556) 2020-10-19 22:04:01 -07:00
Dong-hee Na 6595cb0af4
bpo-35293: Remove RemovedInSphinx40Warning (GH-22198)
* 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>
2020-09-18 18:22:36 +09:00
Pablo Galindo a5634c4067
bpo-41746: Add type information to asdl_seq objects (GH-22223)
* 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.
2020-09-16 19:42:00 +01:00
Pablo Galindo 5a4a963a6c
Fix invalid escape sequences in the peg_highlight Sphinx extension (GH-22047) 2020-09-02 15:29:38 +01:00
Pablo Galindo 72cabb2aa6
bpo-40939: Use the new grammar for the grammar specification documentation (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>
2020-07-27 11:20:36 -07:00