Rémi Lapeyre
674ee12600
bpo-35397: Remove deprecation and document urllib.parse.unwrap (GH-11481)
2019-05-27 09:43:45 -04:00
Anthony Sottile
22ccb0b490
Fix highlighting in importlib.metadata docs (GH-13575)
2019-05-26 10:30:52 -04:00
Jason R. Coombs
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
Steve Dower
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
Nick Coghlan
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
Pablo Galindo
960bb88376
Fix sphinx deprecation warning about env.note_versionchange() (GH-13236)
2019-05-10 22:58:17 +01:00
Stéphane Wirtel
e9b49d1b4e
Clarify the download unit in the download section (GH-13122)
2019-05-06 11:48:17 -07:00
Susan Su
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
zhsj
45a5fdb91c
bpo-36425: Add Simplified Chinese to the language switcher (GH-12537)
2019-03-28 16:32:25 +01:00
Rémi Lapeyre
96831c7fcf
bpo-30670: Add pp function to the pprint module (GH-11769)
2019-03-22 10:22:20 -07:00
Andre Delfino
b420428cf5
Document actual string.punctuation value. (GH-12270)
2019-03-14 21:28:31 +02:00
Julien Palard
9db56fb8fa
Doc sidebar: 3.6 has moved to security-fix mode. (GH-11810)
2019-02-10 13:27:12 -08:00
Serhiy Storchaka
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
Steve Dower
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
Julien Palard
6b73bb523a
bpo-31146: Don't fallback switcher to english on not-yet pusblished languages. (GH-10558)
2018-11-20 17:18:30 +01:00
Julien Palard
64313478bc
bpo-32613: Update window FAQ (GH-5552)
2018-11-14 16:22:27 +01:00
Julien Palard
556d50d03d
Doc: Make all versions sidebars the same for consistency. (GH-10288)
2018-11-08 00:11:49 +01:00
Julien Palard
beed84ca5e
bpo-35015: Doc: Fix internationalisation of the availability directive. (GH-10360)
2018-11-07 22:42:40 +01:00
Stéphane Wirtel
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
Pablo Galindo
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
Xtreak
c3f52a59ce
bpo-35036: Remove empty log line in the suspicious.py tool (GH-10024)
...
Previous to commit ee171a2
the logline was working because of self.info() (now
deprecated) defaults to an empty message.
2018-10-21 13:57:32 +01:00
Pablo Galindo
ee171a26c1
Stop using deprecated logging API in Sphinx suspicious checker (GH-9875)
2018-10-15 20:07:23 +01:00
Stéphane Wirtel
e385d0661e
bpo-34967: Sphinx is deprecating add_description_unit, use add_object_type (GH-9827)
2018-10-13 08:14:08 +02:00
Cheryl Sabella
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
animalize
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
Petr Viktorin
2d3ff2b5ea
bpo-24937: Replace the extension module porting HOWTO by links to external projects (GH-9317)
2018-09-24 12:42:33 +02:00
Yury Selivanov
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
Yury Selivanov
394374e30c
bpo-33649: Add low-level APIs index. (GH-9364)
2018-09-17 15:35:24 -04:00
Ned Deily
aee5df5e16
Forward port 3.7.0 final changes
2018-06-27 18:45:50 -04:00
Zvezdan Petkovic
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
Dong-hee Na
5779483299
bpo-33378: Add Korean to the language switcher. (GH-6627)
2018-04-28 22:08:22 +02:00
Benjamin Peterson
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
Jon Wayne Parrott
bf63e8d55f
bpo-30607: Use external python-doc-theme (GH-2017)
2018-03-01 16:02:50 -05:00
cocoatomo
0febc05373
bpo-32087: Doc: Make "deprecated-removed" directive translatable (GH-4473)
2018-02-23 20:47:19 +09:00
Ned Deily
07a1892f82
Update Doc build to 3.8
2018-01-31 18:12:38 -05:00
Nick Coghlan
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
Victor Stinner
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
Serhiy Storchaka
05cb728d68
bpo-30349: Raise FutureWarning for nested sets and set operations ( #1553 )
...
in regular expressions.
2017-11-16 12:38:26 +02:00
Victor Stinner
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
Ned Deily
b7cbfe49e3
bpo-31766: restore 3.5 to docs version switchers ( #3969 )
2017-10-12 14:08:43 -04:00
Jelle Zijlstra
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
Ned Deily
e2d0dd2cf9
Remove retired and security branches from active docs ( #3879 )
2017-10-03 22:56:19 -04:00
Dmitry Chestnykh
aecc08ac3a
Docs: correct hashlib.blake2 keyed hashing example (bpo-31560)
2017-09-23 10:18:40 -07:00
Ned Deily
52451fbaaf
Prevent a few make suspicious warnings. ( #3341 )
2017-09-05 01:34:47 -07:00
larryhastings
f9f17346d7
Blurbify master branch. ( #3298 )
...
Blurbify master branch.
2017-09-04 13:30:19 -07:00
Elmar Ritsch
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
Julien Palard
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
Julien Palard
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
Julien Palard
c82b7f332a
bpo-31149: Doc: Add Japanese to the language switcher. ( #3028 )
2017-08-08 23:26:46 +02:00
Julien
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
Ned Deily
5bffcf38aa
Update doc download files size estimates. ( #2771 )
2017-07-20 03:58:46 -04:00
Ned Deily
50f58163a6
bpo-30939: Avoid Sphinx deprecation warning in docs build. ( #2721 )
2017-07-15 15:28:02 -04:00
Victor Stinner
272d888c7b
bpo-29783: Replace codecs.open() with io.open() ( #599 )
2017-06-16 08:59:01 +02:00
Serhiy Storchaka
d97b7dc94b
bpo-30380: Fix Sphinx 1.6.1 warnings. ( #1613 )
...
* Use explicit numbering for footnotes referred by explicit number.
* Restore missed footnote reference in stdtypes.rst.
* Fix literal strings formatting in howto/urllib2.rst.
* Update susp-ignored.csv for zipapp.rst.
* Fix suspicious mark up in Misc/NEWS.
2017-05-16 23:18:09 +03:00
Xiang Zhang
13f1f423fa
bpo-30103: Allow Uuencode in Python using backtick as zero instead of space ( #1326 )
2017-05-03 11:16:21 +08:00
Serhiy Storchaka
5908300e4b
bpo-29995: re.escape() now escapes only special characters. ( #1007 )
2017-04-13 21:06:43 +03:00
Serhiy Storchaka
8fc7bc2b76
bpo-30021: Add examples for re.escape(). ( #1048 )
...
And fix the parameter name.
2017-04-13 19:17:36 +03:00
cocoatomo
f8beb9831a
bpo-29888: Fix the link referring to the "Python download page" (GH-824)
2017-03-26 13:32:24 -04:00
INADA Naoki
c351ce6a2c
bpo-28331: fix impl-detail label is removed when content is translated. (GH-195)
2017-03-08 19:07:13 +09:00
INADA Naoki
e395c4dbe1
bpo-29520: doc: add missing dot (GH-182)
...
3eea8c6
missed dot at the end of paragraph.
2017-02-20 10:22:28 +09:00
INADA Naoki
3eea8c67fa
bpo-29520: doc: fix deprecation warning from 'defindex' template (GH-165)
2017-02-20 02:07:32 +09:00
Mariatta
d4a97d8948
bpo-28929: Link the documentation to its source file on GitHub ( #35 )
...
* bpo-28929: Link the documentation to its source file on GitHub
Change the documentation's `Show Source` link on the left menu
to GitHub source file.
* change version to master
2017-02-12 13:07:05 -08:00
Brett Cannon
79ab8be05f
Support "bpo-" in Misc/NEWS ( #1 )
2017-02-10 17:10:13 -06:00
Nick Coghlan
c7a24a7330
Merge issue #26355 fix from 3.6
2017-02-09 16:09:03 +01:00
Nick Coghlan
e1857579f8
Merge issue #26355 fix from Python 3.5
2017-02-09 16:08:17 +01:00
Nick Coghlan
e66244521c
Issue #26355 : Specify canonical URLs in docs pages
...
Add canonical header link on each page to corresponding major
version of the documentation.
Patch by Matthias Bussonnier.
2017-02-09 16:03:59 +01:00
Martin Panter
f24bcccefd
Issue #28822 : Add susp-ignored entry for NEWS; fix grammar
2017-01-29 23:37:56 +00:00
Martin Panter
ba964cc5f7
Issues #29349 : Merge Py 2.6+ compatibility from 3.6
2017-01-29 23:37:24 +00:00
Martin Panter
b154113251
Issues #29349 : Merge Py 2.6+ compatibility from 3.5
2017-01-29 23:34:52 +00:00
Martin Panter
9a454021a4
Issue #29349 : Use __future__ print_function; Sphinx may use Python 2.6+
2017-01-29 23:33:13 +00:00
Martin Panter
c654f0acf9
Issues #29349 : Add NEWS for 3.7; use “with” statement
2017-01-29 10:17:17 +00:00
Martin Panter
3a6dc19f6e
Issues #29349 : Merge Py 2 fix 3.6
2017-01-29 10:16:28 +00:00
Martin Panter
e61592e7e1
Issues #29349 : Merge Py 2 fix 3.5
2017-01-29 10:09:43 +00:00
Martin Panter
8f3fb72309
Issue #29349 : Fix Python 2 syntax in documentation build code
2017-01-29 10:05:02 +00:00
INADA Naoki
f25dec904c
Issue #29062 : Doc: Fix make suspicious
2017-01-14 21:04:40 +09:00
INADA Naoki
2e1b6ea4b7
Issue #29062 : Doc: Fix make suspicious
2017-01-14 21:04:21 +09:00
Ned Deily
9800686714
Update documentation index sidebar for 3.6.0 release.
2016-12-23 04:17:38 -05:00
Ned Deily
e31b15c4ce
Update documentation index sidebar for 3.6.0 release.
2016-12-23 04:13:31 -05:00
Ned Deily
864a78ed72
Issue #28900 : Update documentation sidebar for 3.6.0rc.
2016-12-07 23:38:30 -05:00
Ned Deily
098f85bb7d
Issue #28900 : Update documentation sidebar for 3.6.0rc.
2016-12-07 23:37:12 -05:00
Ned Deily
932d40abf7
Issue #28900 : Update documentation sidebar for 3.6.0rc.
2016-12-07 23:34:49 -05:00
Zachary Ware
3d1caab7b9
Merge with 3.6
2016-11-17 23:31:29 -06:00
Zachary Ware
d23881e3a0
Ignore newly added suspicious line
2016-11-17 23:30:27 -06:00
Zachary Ware
6743999d74
Remove unused suspicious rules
2016-10-25 21:49:19 -05:00
Zachary Ware
ec9357b90c
Ignore harmless suspicious markup
2016-10-25 21:43:41 -05:00
Steve Dower
765285337a
Issue #28251 : Improvements to help manuals on Windows.
2016-09-22 17:09:56 -07:00
Steve Dower
fb4a96a58f
Issue #28251 : Improvements to help manuals on Windows.
2016-09-22 17:07:56 -07:00
Ned Deily
7582bcaa8f
Make 3.7 the current dev version in the html version of the docs.
2016-09-20 15:00:53 -04:00
Ned Deily
a327331cec
Make 3.7 the current dev version in the html version of the docs.
2016-09-20 15:00:07 -04:00
Ned Deily
0112625fba
Change SOURCE_URI for pydoc source URLs to point to 3.6 branch
2016-09-12 10:56:13 -04:00
Ned Deily
ef71d20548
Add some additional suspicious exemption rules for recent doc changes.
2016-09-11 15:49:37 -04:00
Zachary Ware
b44acebc7b
Actually fix suspicious markup, I ignored it too readily
2016-09-09 17:47:38 -07:00
Zachary Ware
39b42ae8db
Remove line numbers from suspicious rules
2016-09-09 17:38:28 -07:00
Zachary Ware
12aeb78fd2
Fix suspicious markup
2016-09-09 15:46:14 -07:00
Zachary Ware
9539963a44
Remove unused suspicious rules
2016-09-09 13:26:47 -07:00
Zachary Ware
9c85828463
Closes #19489 : Merge with 3.5
2016-09-09 13:11:58 -07:00
Zachary Ware
a3090a4b79
Issue #19489 : Move the search box from sidebar to header and footer.
2016-09-09 13:11:27 -07:00
Gregory P. Smith ext:(%20%5BGoogle%20Inc.%5D)
a68c1bca7b
Remove legacy "from __future__ import with_statement" lines.
2016-09-08 13:47:41 -07:00
Benjamin Peterson
dfc853c527
shut up some perfectly innocent reST in hashlib-blake2
2016-09-06 14:37:37 -07:00
Martin Panter
d2fe862bab
Issue #27285 : Cleanup leftover susp-ignored entry after text was changed
2016-07-16 07:17:46 +00:00