Commit Graph

924 Commits

Author SHA1 Message Date
Miss Islington (bot) 7d35553138
bpo-35075: Fix broken url in the pprint documentation (GH-10201)
https://bugs.python.org/issue35075
(cherry picked from commit bf46a09dec)

Co-authored-by: Pablo Galindo <Pablogsal@gmail.com>
2018-11-01 14:33:52 -07:00
Miss Islington (bot) 514bbfc7fc
bpo-34967: Sphinx is deprecating add_description_unit, use add_object_type (GH-9827)
(cherry picked from commit e385d0661e)

Co-authored-by: Stéphane Wirtel <stephane@wirtel.be>
2018-10-15 23:46:38 -07:00
Cheryl Sabella b248a8c9a5 [3.7] bpo-11233: Create availability directive for documentation (GH-9692) (GH-9830)
Replace "Availability: xxx" with ".. availability:: xxx" in the doc.
 Original patch by Georg Brandl.

 Co-Authored-By: Georg Brandl <georg@python.org>
 (cherry picked from commit 2d6097d027)

 Co-authored-by: Cheryl Sabella <cheryl.sabella@gmail.com>
2018-10-15 22:52:26 +02:00
Miss Islington (bot) c4c86fad80
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.
(cherry picked from commit 6261ae9b01)

Co-authored-by: animalize <animalize@users.noreply.github.com>
2018-10-08 14:26:55 -07:00
Yury Selivanov 581890cda3
bpo-34733: Return of the docs search bar (GH-9431)
Partially revert changes to Doc/tools/templates/layout.html
accidentally committed in 512d710109.
2018-09-19 17:51:17 -04:00
Miss Islington (bot) 73c0006e71
bpo-33649: Add a high-level section about Futures; few quick fixes (GH-9403)
Co-authored-by: Elvis Pranskevichus <elvis@magic.io>
(cherry picked from commit 471503954a)

Co-authored-by: Yury Selivanov <yury@magic.io>
2018-09-18 15:09:51 -07:00
Yury Selivanov 512d710109
bpo-33649: Backport asyncio docs from 'master' to 3.7 (GH-9377) 2018-09-17 19:35:30 -04:00
Ned Deily 1bf9cc5093 3.7.0 final 2018-06-26 23:07:35 -04:00
Miss Islington (bot) d504108a88 bpo-13631: Fix the order of initialization for readline libedit on macOS. (GH-6915) (GH-6928)
The editline emulation needs to be initialized *after* the name is
defined. This fixes the long open issue.
(cherry picked from commit c2f082e9d1)

Co-authored-by: Zvezdan Petkovic <zpetkovic@acm.org>
2018-05-17 03:27:33 -04:00
Miss Islington (bot) 1487c37e7e
bpo-33378: Add Korean to the language switcher. (GH-6627)
(cherry picked from commit 5779483299)

Co-authored-by: Dong-hee Na <donghee.na92@gmail.com>
2018-04-28 13:23:45 -07:00
Miss Islington (bot) 7899153c1f
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.
(cherry picked from commit acfb087f9f)

Co-authored-by: Benjamin Peterson <benjamin@python.org>
2018-04-16 23:32:43 -07:00
Mariatta 079d75d099
bpo-32924: Fix the Show Source url in the docs. (GH-5835)
The Show Source link in Python 3.7 docs is pointing to GitHub's master branch.
It should point to the 3.7 branch.
2018-02-23 10:02:30 -08:00
Miss Islington (bot) c673a62d5f
bpo-32087: Doc: Make "deprecated-removed" directive translatable (GH-4473)
(cherry picked from commit 0febc05373)

Co-authored-by: cocoatomo <cocoatomo77@gmail.com>
2018-02-23 04:08:45 -08:00
Ned Deily 7f38637853 Update Doc build for split off of 3.7 branch 2018-01-31 18:24:44 -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