e09d94a140
bpo-46231: Remove invalid_* rules preceded by more tokens from the grammar docs (GH-30341)
2022-01-04 10:42:15 +00:00
3ea574f35b
Fix some false positives of documentation syntax problems
2021-12-08 22:22:55 +00:00
d32316a2aa
bpo-42238: [doc]: Hide false positive in make suspicious. (GH-29636)
2021-11-19 19:11:24 +01:00
bda69abe84
[doc]: Fix missing space in c-api/init.rst and add rstlint rule (GH-28988)
2021-10-19 21:13:24 +02:00
9fa930dd48
[doc]: update susp-ignored.csv after a98b273c. (GH-28827)
2021-10-09 10:25:00 +02:00
241bda785a
[doc] Fix typos found using codespell (GH-28744)
...
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
2021-10-05 23:48:44 +02:00
37272f5800
bpo-42238: [doc] remove unused, and deduplicate, suspicious ignore rules. (GH-28137)
2021-09-06 08:50:48 +02:00
21fa854792
bpo-42238: [doc] Some more make suspicious false positives. (GH-27945)
2021-08-26 10:45:01 +02:00
7cba23164c
bpo-39452: Rewrite and expand __main__.rst ( #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>
2021-08-24 19:01:41 +02:00
08830a4f75
bpo-42560: rewrite of Tkinter docs "life preserver" (GH-27842)
...
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
2021-08-23 20:30:53 +02:00
058fb35b57
bpo-44854: Remove trailing whitespaces (GH-27689)
2021-08-09 21:32:54 +03:00
fbf10080bb
bpo-42238: Fix small rst issue in NEWS.d/. ( #27238 )
2021-07-19 16:34:48 +02:00
af4a2dcc40
docs: add the word 'official' (GH-26849)
2021-07-08 09:58:13 -05:00
01331f1a3c
bpo-42238: rstlint: Add two new checks. (GH-26966)
2021-07-03 10:35:02 +02:00
92d1064727
bpo-44106: Improve sqlite3 example database contents (GH-26027)
2021-05-19 10:41:19 +03:00
b05955d6f5
bpo-43795: PEP 652 user documentation (GH-25668)
...
- 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
2021-05-11 07:04:33 -07:00
873275e64a
Update references to master to point to main in customsourcelink.html (GH-25993)
2021-05-08 17:13:24 +01:00
c40ab5b699
Update the SOURCE_URI in pyspecific.py to point to the new branch (GH-25977)
2021-05-08 03:43:23 +01:00
60ce8f0be6
bpo-36384: Leading zeros in IPv4 addresses are no longer tolerated (GH-25099)
...
Reverts commit e653d4d8e8
2021-05-02 14:00:35 +02:00
99fdd78200
bpo-43766: Fix TypeGuard docs ( #25660 )
2021-04-27 08:55:08 -07:00
f5c5c0c362
Fix type group capture in the PEG highlight tool (GH-25464)
2021-04-18 00:18:13 +01:00
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
3386ca0b36
bpo-20364: Improve sqlite3 placeholder docs (GH-25003)
2021-04-14 15:28:55 +03:00
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
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
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
cc12888f9b
Remove unused suspicious rule in the docs
2021-03-01 16:48:59 +00:00
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
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
de833b6013
Fix 'make suspicious' for the itertools module (GH-24097)
2021-01-04 17:24:22 +00:00
8c5d0347ef
bpo-34398: Allow glossary results to show up on search page (GH-8773)
2020-12-18 20:00:51 +01:00
b9735420aa
bpo-42238: Check Misc/NEWS.d/next/ for reStructuredText issues. (GH-23802)
2020-12-18 10:48:08 +01:00
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
09490a109f
bpo-42042: Use ids attribute instead of names attribute (GH-22739)
2020-11-14 00:15:17 +09:00
ee2549c2ba
bpo-41028: Doc: Move switchers to docsbuild-scripts. (GH-20969)
2020-11-07 12:28:31 +01:00
148c76b27c
Expand and clarify the "Invoking Descriptors" section of the Descriptor HowTo (GH-23078)
2020-11-01 09:10:06 -08:00
3317466061
bpo-42061: Document __format__ for IP addresses (GH-23018)
...
Automerge-Triggered-By: GH:ericvsmith
2020-10-29 15:17:59 -07:00
8d3d7314d4
Create a primer section for the descriptor howto guide (GH-22906)
2020-10-23 12:55:39 -07:00
283f9a253b
Remove 3.5 from Doc version switcher in master. ( #22886 )
2020-10-22 06:16:21 -07:00
fb2e94692e
Doc: Do not suggest `s[::-1]` for reversed order (GH-22457)
2020-10-21 17:25:07 +09:00
871934d4cf
bpo-4356: Add key function support to the bisect module (GH-20556)
2020-10-19 22:04:01 -07:00
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
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
5a4a963a6c
Fix invalid escape sequences in the peg_highlight Sphinx extension (GH-22047)
2020-09-02 15:29:38 +01:00
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
7f03445d01
Doc: fix import of asdl.py when called from outside Doc/. (GH-21529)
2020-07-20 09:48:40 +02:00
a103e73ce8
bpo-40742: Doc: fix parallel build. (GH-21237)
2020-07-06 22:28:15 +02:00
735d902b36
bpo-40798: Generate a different message for already removed elements (GH-20483)
2020-05-30 09:47:32 +02:00
19e3e00264
Doc: Python 3.10 in sidebar and version switcher. (GH-20209)
2020-05-19 14:26:43 +02:00
b7a78ca74a
bpo-40517: Implement syntax highlighting support for ASDL (GH-19967)
2020-05-07 13:57:26 -07:00
eff870b618
Revert "bpo-40517: Implement syntax highlighting support for ASDL ( #19928 )" ( #19950 )
...
This reverts commit d60040ba22
2020-05-05 22:33:55 -07:00
d60040ba22
bpo-40517: Implement syntax highlighting support for ASDL ( #19928 )
2020-05-05 22:24:39 -07:00
39c34933fc
Fix download.html (GH-18902)
...
`<tt>` is not allowed.
Co-authored-by: Kyle Stanley <aeros167@gmail.com>
2020-03-11 13:23:24 +09:00
13d52c2686
bpo-34822: Simplify AST for subscription. (GH-9605)
...
* 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.
2020-03-10 18:52:34 +02:00
21da76d1f1
bpo-34788: Add support for scoped IPv6 addresses (GH-13772)
...
Automerge-Triggered-By: @asvetlov
2020-02-26 06:33:57 -08:00
f4800b8ed3
Doc: Change Python 2 status to EOL. (GH-17885)
2020-01-07 15:52:44 +09:00
386d00cc34
Remove use of deprecated `array.fromstring` method (GH-17332)
2019-11-26 15:31:09 +09:00
138ccbb022
bpo-38738: Fix formatting of True and False. (GH-17083)
...
* "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>".
2019-11-12 16:57:03 +02:00
85c6f8c65c
bpo-38592 Add pt-br switcher to Python Docs website (GH-16924)
...
* 📜 🤖 Added by blurb_it.
2019-10-27 09:30:12 +01:00
d898d20e8c
bpo-38557: Improve documentation for list and tuple C API. (GH-16925)
2019-10-26 22:59:18 +03:00
3f36043db2
Update doc switcher list for 3.8.0 (GH-16809)
2019-10-15 17:26:05 -04:00
4504b4500d
Doc: 3.8 is now stable. (GH-16790)
2019-10-14 18:13:38 -04:00
15ae75d660
bpo-38294: Add list of no-longer-escaped chars to re.escape documentation. (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.
2019-10-07 23:54:35 +03:00
2c910c1e73
bpo-36675: Remove obsolete code. (GH-16024)
...
Does no longer work since Sphinx moved the trim_doctest_flag option in
the configuration.
2019-09-12 12:23:53 +01:00
97b817eae3
bpo-33187: Document ElementInclude (XInclude) support in ElementTree (GH-8861)
2019-09-11 15:09:53 +01:00
c3d679fd39
bpo-37504: Fix documentation build with texinfo builder (GH-14606)
...
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
2019-09-10 15:40:50 +01:00
17499d8270
bpo-38086: Sync importlib.metadata with importlib_metadata 0.21. (GH-15840)
...
https://gitlab.com/python-devs/importlib_metadata/-/tags/0.21
2019-09-10 14:53:31 +01:00
63c98ed2d2
Doc: Fix PDF build (NoUri). (GH-15739)
2019-09-09 12:54:56 +02:00
e1786b5416
bpo-36853: Fix suspicious.py to actually print the unused rules ( #13579 )
...
* Fix suspicious.py to actually print the unused rules
* Fix the other `self.warn` calls
2019-09-02 12:01:23 -04:00
22f0483d44
Bpo-37644: update suspicious.csv for distutils/examples (GH-14885)
2019-07-21 20:01:56 +02:00
6a61714cde
Replace backquote with command substitution in subprocess doc example (GH-13941)
...
Replace backquotes with POSIXy command substitution in example.
2019-07-16 07:55:19 -07:00
e226e83d36
bpo-37363: Add audit events on startup for the run commands (GH-14524)
2019-07-01 16:03:53 -07:00
44f91c388a
bpo-37390: Add audit event table to documentations (GH-14406)
...
Also updates some (unreleased) event names to be consistent with the others.
2019-06-27 10:47:59 -07:00
60419a7e96
bpo-37363: Add audit events for a range of modules (GH-14301)
2019-06-24 08:42:54 -07:00
ca7b504a4d
bpo-37111: Add 'encoding' and 'errors' parameters to logging.basicCon… (GH-14008)
2019-06-17 17:40:52 +01:00
552951563c
Doc: Remove an ugly space before a dot. (GH-14123)
2019-06-16 10:25:05 +02:00
cfa0394b97
Doc: Deprecation header: More precise wording. (GH-14109)
2019-06-15 10:21:37 -04:00
59e7bbcaa4
Doc: Python 3.9 in sidebar and version switcher. (GH-13824)
2019-06-04 19:15:32 -04:00
9ab2fb1c68
Bump to 3.9.0a0
2019-06-04 22:12:32 +02:00
3b5deb0116
Python 3.8.0b1
2019-06-04 19:44:34 +02:00
46ed90dd01
Doc: Add an optional obsolete header. (GH-13638)
2019-05-29 18:34:04 +02:00
3880f263d2
bpo-36933: Remove sys.set_coroutine_wrapper (marked for removal in 3.8) (GH-13577)
...
It has been documented as deprecated and to be removed in 3.8;
From a comment on another thread – which I can't find ; leave get_coro_wrapper() for now, but always return `None`.
https://bugs.python.org/issue36933
2019-05-28 00:10:59 -07:00
674ee12600
bpo-35397: Remove deprecation and document urllib.parse.unwrap (GH-11481)
2019-05-27 09:43:45 -04:00
22ccb0b490
Fix highlighting in importlib.metadata docs (GH-13575)
2019-05-26 10:30:52 -04:00
1bbf7b661f
bpo-34632: Add importlib.metadata (GH-12547)
...
Add importlib.metadata module as forward port of the standalone importlib_metadata.
2019-05-24 16:59:01 -07:00
b82e17e626
bpo-36842: Implement PEP 578 (GH-12613)
...
Adds sys.audit, sys.addaudithook, io.open_code, and associated C APIs.
2019-05-23 08:45:22 -07:00
dae1229729
bpo-36797: Prune more legacy distutils documentation (GH-13092)
...
Removes more legacy distutils documentation, and more clearly
marks what is left as potentially outdated, with references to
setuptools as a replacement.
2019-05-14 22:04:30 +10:00
960bb88376
Fix sphinx deprecation warning about env.note_versionchange() (GH-13236)
2019-05-10 22:58:17 +01:00
e9b49d1b4e
Clarify the download unit in the download section (GH-13122)
2019-05-06 11:48:17 -07:00
081158e3ba
bpo-33043: Add a Contributing to Docs link and Update the Found a Bug Page ( #12006 )
...
* changes to html file -> added contributing to docs link at the end of the page
* revisions to the dealing with bugs page. added more links in the documentation bugs section
* 📜 🤖 Added by blurb_it.
* Update Doc/bugs.rst
Updated Doc/bugs.rst in accordance with willingc and JulienPalard suggestions.
Co-Authored-By: suhearsawho <susansu.software@gmail.com>
2019-03-28 18:55:24 -07:00
45a5fdb91c
bpo-36425: Add Simplified Chinese to the language switcher (GH-12537)
2019-03-28 16:32:25 +01:00
96831c7fcf
bpo-30670: Add pp function to the pprint module (GH-11769)
2019-03-22 10:22:20 -07:00
b420428cf5
Document actual string.punctuation value. (GH-12270)
2019-03-14 21:28:31 +02:00
9db56fb8fa
Doc sidebar: 3.6 has moved to security-fix mode. (GH-11810)
2019-02-10 13:27:12 -08:00
83dd4e87a6
bpo-18085: Update refcounts.dat. (GH-11247)
...
Fixed some errors in refcounts.dat, remove functions removed in
Python 3, and add more entries for documented functions. This will
add several automatically generated notes about return values.
2018-12-20 09:33:58 +02:00
afe17a7bee
bpo-35482: Fixes HTML escaping in CHM index and build location of NEWS file (GH-11224)
2018-12-19 18:20:06 -08:00
6b73bb523a
bpo-31146: Don't fallback switcher to english on not-yet pusblished languages. (GH-10558)
2018-11-20 17:18:30 +01:00
64313478bc
bpo-32613: Update window FAQ (GH-5552)
2018-11-14 16:22:27 +01:00
556d50d03d
Doc: Make all versions sidebars the same for consistency. (GH-10288)
2018-11-08 00:11:49 +01:00
beed84ca5e
bpo-35015: Doc: Fix internationalisation of the availability directive. (GH-10360)
2018-11-07 22:42:40 +01:00
Pablo Galindo Salgado
Julien Palard
Christian Clauss
Jack DeVries
Mark Roseman
Serhiy Storchaka
Ned Batchelder
Erlend Egeberg Aasland
Petr Viktorin
Christian Heimes
Ken Jin
Victor Stinner
Jules Lasne
Brandt Bucher
Ammar Askar
Matěj Cepl
Dong-hee Na
Raymond Hettinger
Teugea Ioan-Teodor
larryhastings
Andre Delfino
Dong-hee Na
Florian Dahlitz
Batuhan Taskaya
Inada Naoki
opavlyuk
David Coles
Marco Rougeth
Ned Deily
Ricardo Bánffy
Anjali Bansal
Dmitry Shachnev
Jason R. Coombs
Anthony Sottile
David Jones
Steve Dower
Vinay Sajip
Łukasz Langa
Matthias Bussonnier
Rémi Lapeyre
Steve Dower
Nick Coghlan
Stéphane Wirtel
Susan Su
zhsj