Commit Graph

20356 Commits

Author SHA1 Message Date
Mariatta ff64a24c67 Fix broken `Show Source` links on documentation pages (GH-3113) (GH-3125)
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".
(cherry picked from commit b9ff498793)
2017-08-18 06:21:33 -07:00
Julien Palard fcecb0e365 Update the language selection in the docs language switch. (GH-3114) (#3115)
Change the option for `Français` into `French` to be consistent with the other language selections that are already in English.
(cherry picked from commit b616b97299)
2017-08-17 16:37:00 +02:00
Christian Heimes 7f6a13bd56 [3.6] bpo-30714: ALPN changes for OpenSSL 1.1.0f (#3093)
OpenSSL 1.1.0 to 1.1.0e aborted the handshake when server and client
could not agree on a protocol using ALPN. OpenSSL 1.1.0f changed that.
The most recent version now behaves like OpenSSL 1.0.2 again. The ALPN
callback can pretend to not been set.

See https://github.com/openssl/openssl/pull/3158 for more details

Signed-off-by: Christian Heimes <christian@python.org>
(cherry picked from commit a5c1bab352)
2017-08-15 10:45:40 +02:00
Julien Palard e8e7fba0b2 bpo-31159: fix language switch regex on unknown yet built languages. … (#3051)
* 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.
(cherry picked from commit 122081deef)

* bpo-31149: Doc: Add Japanese to the language switcher. (#3028)

(cherry picked from commit c82b7f332a)
2017-08-10 16:54:26 +02:00
Julien Palard e93135dbb2 bpo-31045: Language switch (#2652) (#3023)
* 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.

(cherry picked from commit dff9b5f9d6)
2017-08-08 14:13:53 +02:00
Mariatta 9b3abacf87 [3.6] Improve grammar in asyncio documentation (GH-2993) (GH-2994)
"not only is it .." is the correct form, as opposed to:
"not only it is ..."
(cherry picked from commit 87c3c5de73)
2017-08-04 00:33:33 +10:00
Terry Jan Reedy 4c7b368de7 [3.6] bpo-30803: clarify truth value testing documentation (GH-2508) (#2946)
Initial patch by Peter Thomassen.
(cherry picked from commit caa1280)
2017-07-29 18:56:06 -04:00
Mariatta e05119ad4e Fix trivial typo in multiprocessing documentation (GH-2930) (GH-2940)
(cherry picked from commit 6fcb69dad5)
2017-07-28 19:55:23 -07:00
Mariatta 0dbfab2ac7 Add the link to asyncio source code in the docs (GH-2373) (GH-2884)
(cherry picked from commit 627d2c8e8d)
2017-07-25 21:05:17 -07:00
Mariatta 59e6ab15e4 bpo-26506: hex() documentation: mention %x % int (GH-2525) (GH-2870)
(cherry picked from commit 67ba4fa467)
2017-07-25 11:04:08 -07:00
Terry Jan Reedy 548a6889f4 [3.6] Minor typo in curses.rst (GH-2763) (#2853)
I found a tiny typo in the curses how-to: changed 'Thy' to 'The' on line 68.
(cherry picked from commit d439d3e)
2017-07-24 18:54:53 -04:00
Nicholas df5837b5a9 [3.6] bpo-30964: Mention ensurepip in package installation docs (GH-2797)
Adds a new 'Pip not installed' section that covers
running `ensurepip` manually, and also references
the relevant section of the Python Packaging User
Guide.

(cherry picked from commit b3527bfefd)
2017-07-21 16:44:43 +10:00
Trey Hunner ef4231adb7 bpo-30466: Add brief explanation of classes to tutorial (GH-1804) (GH-2700) 2017-07-20 20:10:54 -07:00
Mariatta 7f58994842 [3.6] Fix typo in Turtle Docs: yingyang -> yinyang (GH-2770) (GH-2778)
(cherry picked from commit fff2a21057)
2017-07-20 07:14:05 -07:00
Ned Deily e0d306f682 Update doc download files size estimates. (#2771) (#2772) 2017-07-20 04:19:22 -04:00
Steve Dower e99d3a52a5 [3.6] bpo-30450: Improved logic for obtaining dependencies (#2751)
Adds alternate download approach for nuget.exe
Fall back to git.exe if no Python is found. (#2739)
Also check whether git.exe is on PATH if it will be used.
Add support for HOST_PYTHON variable.
Clear internal environment variables used in find_python.bat
Use HOST_PYTHON as the actual Python if it is recent enough.
Adds HOST_PYTHON variable to AppVeyor configuration
2017-07-19 09:11:08 +02:00
Ned Deily bbd0f423d2 bpo-30939: Avoid Sphinx deprecation warning in docs build. (#2721) (#2722)
(cherry picked from commit 50f58163a6)
2017-07-15 16:56:13 -04:00
Łukasz Rogalski ea9cbe0a5c Doc that 'sorted' args are keyword-only, fix 'reverse' default (#2709)
backport
2017-07-14 15:57:19 -04:00
Berker Peksag 23e2c3d193 Remove outdated FOX from GUI FAQ (GH-2538)
FXpy doesn't have a Python 3 port and it only
supports Python 2.2 and older versions.

Reported by Alex Walters on docs@p.o.

(cherry picked from commit d3ed2877a7)
2017-07-04 09:27:35 +03:00
Kojo Idrissa 03af428242 [3.6] bpo-29933: Improve set_write_buffer_limits description (GH-2262) (GH-2532)
Improve the description of the high and low parameters for set_write_buffer_limits.
Also fixed a small grammatical issue.
(cherry picked from commit 5200a7c7f9)
2017-07-01 19:48:07 -07:00
regexaurus c4cc5534fd Clarification to the `break` statement (GH-2453) (#GH-2457)
Clarify that the break statement breaks out of the innermost enclosing for or while loop.
(cherry picked from commit 36fc896740)
2017-06-27 19:38:22 -07:00
Benjamin Peterson bae5ddab2c fix some reference to Unicode 8 that should be to Unicode 9 (#2346) 2017-06-22 23:11:52 -07:00
Mariatta d79ac2c246 [3.6] bpo-30709: Improve code example in Descriptor HowTo doc (GH-2339) (GH-2342)
(cherry picked from commit b066edfb1b)
2017-06-22 21:24:43 -07:00
Mariatta 8baf78b98f [3.6] bpo-30619: Clarify typing.Union documentation (GH-2326) (GH-2337)
When a class and its subclass are present, the latter is skipped.
(cherry picked from commit 6580c19bbb)
2017-06-22 18:52:57 -07:00
Serhiy Storchaka a1115e1a04 [3.6] bpo-29755: Fixed the lgettext() family of functions in the gettext module. (GH-2266) (#2297)
They now always return bytes.

Updated the gettext documentation..
(cherry picked from commit 26cb4657bc)
2017-06-20 18:06:35 +03:00
Mariatta 0a4fe1d857 [3.6] bpo-30420: List cwd parameter in subprocess convenience APIs (GH-1685) (GH-2253)
Partially clarify the subprocess convenience API documentation by
explicitly listing the `cwd` parameter in their abbreviated signatures.

While this has been merged as an improvement, it doesn't fully
resolve the issue, as the `cwd` should also be covered in the
"Frequently Used Arguments" section, and the fact these APIs
pass unlisted keyword arguments down to the lower level APIs
is currently still unclear.
(cherry picked from commit 368cf1d206)
2017-06-19 20:28:16 -07:00
Mariatta 304a96e586 bpo-30176: Add missing curses cell attributes constants (GH-1302). (GH-2241)
(cherry picked from commit 116dd5eba6)
2017-06-16 07:19:56 -07:00
Mariatta 6a90a12470 bpo-30656: Fix Python C API Module Objects documentation (GH-2170) (GH-2230)
`PyModule_New()` now refers to `PyModule_NewObject()`
(cherry picked from commit 2d0afef82a)
2017-06-15 18:49:43 -07:00
Mariatta 789f47ebb5 bpo-30659 : Use ** for kwargs in namedtuple._replace() signature (GH-2173) (GH-2195)
(cherry picked from commit 184bd82ba8)
2017-06-14 11:59:37 -07:00
csabella dd47b1944d Fix trivial typo in Python Setup documentation (GH-2185) (GH-2188)
Replace platform with platforms.
(cherry picked from commit 4ebf03d109)
2017-06-14 09:26:41 -07:00
terryjreedy 22d909f8c2 [3.6]bpo-25514: Improve IDLE's connection refused message (#2177) (#2178)
When IDLE fail to start because the socket connection fails, direct people to a new subsection of the IDLE doc listing various causes and remedies.
(cherry picked from commit 188aedf8bb)
2017-06-13 22:13:15 -04:00
Antoine Pitrou d0d63dc1e8 [3.6] Mention how to disable signal fd wakeup (GH-2140) (#2149)
(cherry picked from commit d79c1d4a94)
2017-06-13 10:23:13 +02:00
Mariatta 81c05ccc10 bpo-6519: Improve Python Input Output Tutorial (GH-2143) (GH-2145)
Move up the discussion about 'with' keyword, so it appears earlier in the document.
(cherry picked from commit bd4e9e0ca9)
2017-06-12 22:40:18 -07:00
Marco Buttu f59cac4b64 bpo-30217: add the operators ~ and | to the index (GH-1502) (GH-2136)
(cherry picked from commit dc980dfbcf)
2017-06-12 12:41:42 -07:00
Nick Coghlan e1b690370f bpo-23404: `make regen-all` What's New entry (#2128)
While the build changes won't affect most users,
they may affect redistributors and folks building
their own Python binaries from source.
2017-06-12 22:28:12 +10:00
Mariatta 47c9decb5f bpo-30621: Update Input Output Tutorial Example(GH-2074) (GH-2118)
import json before using json module
(cherry picked from commit 1dbce04d0e)
2017-06-11 18:59:05 -07:00
Benjamin Peterson 2737291134 backport ssl doc fixes (#2117)
* clarify recv() and send() on SSLObject (#2100)

SSLObject has recv() and send(), but they don't do any network io.

* remove extra word (#2101)
2017-06-11 11:53:14 -07:00
Zachary Ware f57e34b672 [3.6] Use Travis to make sure all generated files are up to date (GH-2080) (GH-2092)
(cherry picked from commit 0afbabe245)

Also fixes some line endings missed in GH-840 backport.
2017-06-11 11:30:57 -05:00
KatherineMichel 865ed9ea67 bpo-30312: Small correction in datastructures set code sample (GH-2081) (GH-2085)
(cherry picked from commit ca81615344)
2017-06-10 13:33:57 -07:00
Mariatta 76eabd3a21 bpo-25409: Clarify fnmatch and fnmatchcase documentation (GH-1535) (GH-2065)
Mention that fnmatchcase does not call normcase, and fnmatch does.
(cherry picked from commit e5f6e86c48)
2017-06-10 07:25:33 -07:00
Mariatta 10c9a09ef4 [3.6] bpo-30335: Add deprecation alias entry for assertNotRegexpMatches (GH-1536) (GH-2055)
Document that assertNotRegexpMatches is a deprecated alias for assertNotRegex.
(cherry picked from commit 74921ed894)
2017-06-09 18:33:31 -07:00
Mariatta af609a00a6 bpo-24755: Document asyncio.wrap_future (GH-603) (GH-2019)
(cherry picked from commit 824f687912)
2017-06-09 07:32:46 -07:00
Nick Coghlan c422959dac [3.6] bpo-19180: Updated references for RFC 1750, RFC 3280 & RFC 4366
* RFC 1750 has been been obsoleted by RFC 4086.
* RFC 3280 has been obsoleted by RFC 5280.
* RFC 4366 has been obsoleted by RFC 6066.
(cherry picked from commit 63c2c8ac17)
2017-06-09 22:37:53 +10:00
gfyoung 063f0b3583 bpo-29596: Improve clinic howto documentation (GH-1710) (GH-1976)
Clarify that `two-pass` buffer can only be dumped once, and it prints out all text sent to it during all processing, even from Clinic blocks *after* the dumping point.
2017-06-06 14:17:18 -07:00
wim glenn b25b7254d9 bpo-30583: Fix typo in datetime dateutil documentation (GH-1972) (GH-1974)
Replace `datetuil` into `dateutil`
(cherry picked from commit 53f2af1655)
2017-06-06 12:32:14 -07:00
Nick Coghlan 798cfb2123 bpo-30052: Always regenerate cross-references (GH-1339) (GH-1921)
The patch for bpo-30052 changed the preferred link target
for :func:`bytes` and :func`bytearray` references to be the
respective type definitions rather than the corresponding
builtin function entries.

This patch changes the daily documentation builds to disable
the output caching in Sphinx, in order to ensure that
cross-reference changes like this one are reliably picked
up and applied automatically after merging.
(cherry picked from commit 7a82f9c2b9)
2017-06-05 19:19:37 -07:00
csabella ce40550acd bpo-30538: Update count() in Functional Programming HOWTO (GH-1919) (GH-1943)
* bpo-30538: Update count() in Functional HOWTO
* bpo-30538: Update enumerate() arguments in Functional HOWTO
(cherry picked from commit 9be4ff359d)
2017-06-04 20:12:23 -07:00
Mariatta 86eb93fae6 bpo-30530: Update Descriptor How To Documentation (GH-1845) (GH-1953)
Update the code example in Functions and Methods section
Remove objtype argument in MethodType
(cherry picked from commit 1bced56567)
2017-06-04 20:06:48 -07:00
Mariatta 1c92c0edca bpo-30052: Link `bytes` & `bytearray` to stdtypes not functions (GH-1271) (GH-1915)
Builtin container types have two potential link targets in the docs:

- their entry in the list of builtin callables
- their type documentation

This change brings `bytes` and `bytearray` into line with other
container types by having cross-references default to linking to
their type documentation, rather than their builtin callable entry..
(cherry picked from commit c6db4811f9)
2017-06-01 21:56:24 -07:00
Matthias Bussonnier e417d12d72 bpo-29660: traceback: Document that etype is ignored in some places. (GH-344) (GH-1913)
(cherry picked from commit cdb89cd)
2017-06-01 20:26:15 -07:00