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
0edc7b1b1a
bpo-35159: Add a link to the devguide in the sidebar of the index (Doc/) (GH-10316)
2018-11-04 21:41:34 +01:00
bf46a09dec
bpo-35075: Fix broken url in the pprint documentation (GH-10201)
...
https://bugs.python.org/issue35075
2018-11-01 05:29:38 -07:00
c3f52a59ce
bpo-35036: Remove empty log line in the suspicious.py tool (GH-10024)
...
Previous to commit ee171a2
2018-10-21 13:57:32 +01:00
ee171a26c1
Stop using deprecated logging API in Sphinx suspicious checker (GH-9875)
2018-10-15 20:07:23 +01:00
e385d0661e
bpo-34967: Sphinx is deprecating add_description_unit, use add_object_type (GH-9827)
2018-10-13 08:14:08 +02:00
2d6097d027
bpo-11233: Create availability directive for documentation (GH-9692)
...
Replace "Availability: xxx" with ".. availability:: xxx" in the doc.
Original patch by Georg Brandl.
Co-Authored-By: Georg Brandl <georg@python.org>
2018-10-12 16:55:20 +02:00
6261ae9b01
bpo-32174: Let .chm document display non-ASCII characters properly (GH-9758)
...
Let .chm document display non-ASCII characters properly
Escape the `body` part of .chm source file to 7-bit ASCII, to fix visual effect on some MBCS Windows systems.
2018-10-08 14:20:54 -07:00
2d3ff2b5ea
bpo-24937: Replace the extension module porting HOWTO by links to external projects (GH-9317)
2018-09-24 12:42:33 +02:00
471503954a
bpo-33649: Add a high-level section about Futures; few quick fixes (GH-9403)
...
Co-authored-by: Elvis Pranskevichus <elvis@magic.io>
2018-09-18 17:55:44 -04:00
394374e30c
bpo-33649: Add low-level APIs index. (GH-9364)
2018-09-17 15:35:24 -04:00
aee5df5e16
Forward port 3.7.0 final changes
2018-06-27 18:45:50 -04:00
c2f082e9d1
bpo-13631: Fix the order of initialization for readline libedit on macOS. (GH-6915)
...
The editline emulation needs to be initialized *after* the name is
defined. This fixes the long open issue.
2018-05-17 02:45:10 -04:00
5779483299
bpo-33378: Add Korean to the language switcher. (GH-6627)
2018-04-28 22:08:22 +02:00
acfb087f9f
fix pydoc-topics to work with Sphinx 1.7 (GH-6475)
...
In fact, we now require a newer Sphinx version because APIs have moved around.
2018-04-16 22:56:46 -07:00
bf63e8d55f
bpo-30607: Use external python-doc-theme (GH-2017)
2018-03-01 16:02:50 -05:00
0febc05373
bpo-32087: Doc: Make "deprecated-removed" directive translatable (GH-4473)
2018-02-23 20:47:19 +09:00
07a1892f82
Update Doc build to 3.8
2018-01-31 18:12:38 -05:00
9b99747386
bpo-31975 (PEP 565): Show DeprecationWarning in __main__ (GH-4458)
...
- primary change is to add a new default filter entry for
'default::DeprecationWarning:__main__'
- secondary change is an internal one to cope with plain
strings in the warning module's internal filter list
(this avoids the need to create a compiled regex object
early on during interpreter startup)
- assorted documentation updates, including many more
examples of configuring the warnings settings
- additional tests to ensure that both the pure Python and
the C accelerated warnings modules have the expected
default configuration
2018-01-08 12:45:02 +10:00
747f48e2e9
bpo-32230: Set sys.warnoptions with -X dev ( #4820 )
...
Rather than supporting dev mode directly in the warnings module, this
instead adjusts the initialisation code to add an extra 'default'
entry to sys.warnoptions when dev mode is enabled.
This ensures that dev mode behaves *exactly* as if `-Wdefault` had
been passed on the command line, including in the way it interacts
with `sys.warnoptions`, and with other command line flags like `-bb`.
Fix also bpo-20361: have -b & -bb options take precedence over any
other warnings options.
Patch written by Nick Coghlan, with minor modifications of Victor Stinner.
2017-12-12 22:59:48 +01:00
05cb728d68
bpo-30349: Raise FutureWarning for nested sets and set operations ( #1553 )
...
in regular expressions.
2017-11-16 12:38:26 +02:00
8c663fd60e
Replace KB unit with KiB ( #4293 )
...
kB (*kilo* byte) unit means 1000 bytes, whereas KiB ("kibibyte")
means 1024 bytes. KB was misused: replace kB or KB with KiB when
appropriate.
Same change for MB and GB which become MiB and GiB.
Change the output of Tools/iobench/iobench.py.
Round also the size of the documentation from 5.5 MB to 5 MiB.
2017-11-08 14:44:44 -08:00
b7cbfe49e3
bpo-31766: restore 3.5 to docs version switchers ( #3969 )
2017-10-12 14:08:43 -04:00
ac317700ce
bpo-30406: Make async and await proper keywords ( #1669 )
...
Per PEP 492, 'async' and 'await' should become proper keywords in 3.7.
2017-10-05 23:24:46 -04:00
e2d0dd2cf9
Remove retired and security branches from active docs ( #3879 )
2017-10-03 22:56:19 -04:00
aecc08ac3a
Docs: correct hashlib.blake2 keyed hashing example (bpo-31560)
2017-09-23 10:18:40 -07:00
52451fbaaf
Prevent a few make suspicious warnings. ( #3341 )
2017-09-05 01:34:47 -07:00
f9f17346d7
Blurbify master branch. ( #3298 )
...
Blurbify master branch.
2017-09-04 13:30:19 -07:00
b9ff498793
Fix broken `Show Source` links on documentation pages (GH-3113)
...
The `Show Source` was broken because of a change made in sphinx 1.5.1
In Sphinx 1.4.9, the sourcename was "index.txt".
In Sphinx 1.5.1+, it is now "index.rst.txt"
2017-08-17 20:23:51 -07:00
b616b97299
Update the language selection in the docs language switch. (GH-3114)
...
Change the option for `Français` into `French` to be consistent with the other language selections that are already in English.
2017-08-17 07:24:02 -07:00
122081deef
bpo-31159: fix language switch regex on unknown yet built languages. ( #3039 )
...
This fix a regex issue (a missing non-matching group around an 'or'
list) and the specific possible case where a translation is built but
not yet in known by the picker, but not explicitly listing possible
languages in the regex.
2017-08-09 17:01:15 +02:00
c82b7f332a
bpo-31149: Doc: Add Japanese to the language switcher. ( #3028 )
2017-08-08 23:26:46 +02:00
dff9b5f9d6
bpo-31045: Language switch ( #2652 )
...
* Doc: Indicate the language
* Renaming version_switcher to switchers (to add language_switcher).
* Adding language switch.
* Doc switchers: Enhance readability of regex parsing versions.
* Doc switchers: Desambiguate the need of a replace(/\/+$/g, '') by proper naming.
* Doc switchers: py3k can't reach js, it's redirected server-side by nginx.
* Doc switchers: Examples matching actual regexes.
* Doc switchers: Better fallback on unexisting translated version.
2017-08-07 10:27:21 +02:00
5bffcf38aa
Update doc download files size estimates. ( #2771 )
2017-07-20 03:58:46 -04:00
50f58163a6
bpo-30939: Avoid Sphinx deprecation warning in docs build. ( #2721 )
2017-07-15 15:28:02 -04:00
272d888c7b
bpo-29783: Replace codecs.open() with io.open() ( #599 )
2017-06-16 08:59:01 +02:00
Raymond Hettinger
Teugea Ioan-Teodor
larryhastings
Andre Delfino
Dong-hee Na
Pablo Galindo
Julien Palard
Florian Dahlitz
Batuhan Taskaya
Inada Naoki
Serhiy Storchaka
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
Xtreak
Cheryl Sabella
animalize
Petr Viktorin
Yury Selivanov
Zvezdan Petkovic
Benjamin Peterson
Jon Wayne Parrott
cocoatomo
Victor Stinner
Jelle Zijlstra
Dmitry Chestnykh
Elmar Ritsch
Julien