Commit Graph

1272 Commits

Author SHA1 Message Date
Christian Clauss 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
Julien Palard 37272f5800
bpo-42238: [doc] remove unused, and deduplicate, suspicious ignore rules. (GH-28137) 2021-09-06 08:50:48 +02:00
Julien Palard 21fa854792
bpo-42238: [doc] Some more make suspicious false positives. (GH-27945) 2021-08-26 10:45:01 +02:00
Jack DeVries 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
Mark Roseman 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
Serhiy Storchaka 058fb35b57
bpo-44854: Remove trailing whitespaces (GH-27689) 2021-08-09 21:32:54 +03:00
Julien Palard fbf10080bb
bpo-42238: Fix small rst issue in NEWS.d/. (#27238) 2021-07-19 16:34:48 +02:00
Ned Batchelder af4a2dcc40
docs: add the word 'official' (GH-26849) 2021-07-08 09:58:13 -05:00
Julien Palard 01331f1a3c
bpo-42238: rstlint: Add two new checks. (GH-26966) 2021-07-03 10:35:02 +02:00
Erlend Egeberg Aasland 92d1064727
bpo-44106: Improve sqlite3 example database contents (GH-26027) 2021-05-19 10:41:19 +03:00
Petr Viktorin 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
Pablo Galindo 873275e64a
Update references to master to point to main in customsourcelink.html (GH-25993) 2021-05-08 17:13:24 +01:00
Pablo Galindo c40ab5b699
Update the SOURCE_URI in pyspecific.py to point to the new branch (GH-25977) 2021-05-08 03:43:23 +01:00
Christian Heimes 60ce8f0be6
bpo-36384: Leading zeros in IPv4 addresses are no longer tolerated (GH-25099)
Reverts commit e653d4d8e8 and makes
parsing even more strict. Like socket.inet_pton() any leading zero
is now treated as invalid input.

Signed-off-by: Christian Heimes <christian@python.org>

Co-authored-by: Łukasz Langa <lukasz@langa.pl>
2021-05-02 14:00:35 +02:00
Ken Jin 99fdd78200
bpo-43766: Fix TypeGuard docs (#25660) 2021-04-27 08:55:08 -07:00
Pablo Galindo f5c5c0c362
Fix type group capture in the PEG highlight tool (GH-25464) 2021-04-18 00:18:13 +01:00
Victor Stinner 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
Erlend Egeberg Aasland 3386ca0b36
bpo-20364: Improve sqlite3 placeholder docs (GH-25003) 2021-04-14 15:28:55 +03:00
Pablo Galindo 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
Victor Stinner 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
Jules Lasne 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
Pablo Galindo cc12888f9b
Remove unused suspicious rule in the docs 2021-03-01 16:48:59 +00:00
Brandt Bucher 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
Pablo Galindo 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
Pablo Galindo de833b6013
Fix 'make suspicious' for the itertools module (GH-24097) 2021-01-04 17:24:22 +00:00
Ammar Askar 8c5d0347ef
bpo-34398: Allow glossary results to show up on search page (GH-8773) 2020-12-18 20:00:51 +01:00
Julien Palard b9735420aa
bpo-42238: Check Misc/NEWS.d/next/ for reStructuredText issues. (GH-23802) 2020-12-18 10:48:08 +01:00
Matěj Cepl 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
Dong-hee Na 09490a109f
bpo-42042: Use ids attribute instead of names attribute (GH-22739) 2020-11-14 00:15:17 +09:00
Julien Palard ee2549c2ba
bpo-41028: Doc: Move switchers to docsbuild-scripts. (GH-20969) 2020-11-07 12:28:31 +01:00
Raymond Hettinger 148c76b27c
Expand and clarify the "Invoking Descriptors" section of the Descriptor HowTo (GH-23078) 2020-11-01 09:10:06 -08:00
Teugea Ioan-Teodor 3317466061
bpo-42061: Document __format__ for IP addresses (GH-23018)
Automerge-Triggered-By: GH:ericvsmith
2020-10-29 15:17:59 -07:00
Raymond Hettinger 8d3d7314d4
Create a primer section for the descriptor howto guide (GH-22906) 2020-10-23 12:55:39 -07:00
larryhastings 283f9a253b
Remove 3.5 from Doc version switcher in master. (#22886) 2020-10-22 06:16:21 -07:00
Andre Delfino fb2e94692e
Doc: Do not suggest `s[::-1]` for reversed order (GH-22457) 2020-10-21 17:25:07 +09:00
Raymond Hettinger 871934d4cf
bpo-4356: Add key function support to the bisect module (GH-20556) 2020-10-19 22:04:01 -07:00
Dong-hee Na 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
Pablo Galindo 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
Pablo Galindo 5a4a963a6c
Fix invalid escape sequences in the peg_highlight Sphinx extension (GH-22047) 2020-09-02 15:29:38 +01:00
Pablo Galindo 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
Julien Palard 7f03445d01
Doc: fix import of asdl.py when called from outside Doc/. (GH-21529) 2020-07-20 09:48:40 +02:00
Julien Palard a103e73ce8
bpo-40742: Doc: fix parallel build. (GH-21237) 2020-07-06 22:28:15 +02:00
Florian Dahlitz 735d902b36
bpo-40798: Generate a different message for already removed elements (GH-20483) 2020-05-30 09:47:32 +02:00
Julien Palard 19e3e00264
Doc: Python 3.10 in sidebar and version switcher. (GH-20209) 2020-05-19 14:26:43 +02:00
Batuhan Taskaya b7a78ca74a
bpo-40517: Implement syntax highlighting support for ASDL (GH-19967) 2020-05-07 13:57:26 -07:00
Raymond Hettinger eff870b618
Revert "bpo-40517: Implement syntax highlighting support for ASDL (#19928)" (#19950)
This reverts commit d60040ba22.
2020-05-05 22:33:55 -07:00
Batuhan Taskaya d60040ba22
bpo-40517: Implement syntax highlighting support for ASDL (#19928) 2020-05-05 22:24:39 -07:00
Inada Naoki 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
Serhiy Storchaka 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
opavlyuk 21da76d1f1
bpo-34788: Add support for scoped IPv6 addresses (GH-13772)
Automerge-Triggered-By: @asvetlov
2020-02-26 06:33:57 -08:00
Inada Naoki f4800b8ed3
Doc: Change Python 2 status to EOL. (GH-17885) 2020-01-07 15:52:44 +09:00
David Coles 386d00cc34 Remove use of deprecated `array.fromstring` method (GH-17332) 2019-11-26 15:31:09 +09:00
Serhiy Storchaka 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
Marco Rougeth 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
Serhiy Storchaka d898d20e8c
bpo-38557: Improve documentation for list and tuple C API. (GH-16925) 2019-10-26 22:59:18 +03:00
Ned Deily 3f36043db2
Update doc switcher list for 3.8.0 (GH-16809) 2019-10-15 17:26:05 -04:00
Julien Palard 4504b4500d Doc: 3.8 is now stable. (GH-16790) 2019-10-14 18:13:38 -04:00
Ricardo Bánffy 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
Julien Palard 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
Anjali Bansal 97b817eae3 bpo-33187: Document ElementInclude (XInclude) support in ElementTree (GH-8861) 2019-09-11 15:09:53 +01:00
Dmitry Shachnev 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
Jason R. Coombs 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
Julien Palard 63c98ed2d2
Doc: Fix PDF build (NoUri). (GH-15739) 2019-09-09 12:54:56 +02:00
Anthony Sottile 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
Ned Deily 22f0483d44
Bpo-37644: update suspicious.csv for distutils/examples (GH-14885) 2019-07-21 20:01:56 +02:00
David Jones 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
Steve Dower e226e83d36
bpo-37363: Add audit events on startup for the run commands (GH-14524) 2019-07-01 16:03:53 -07:00
Steve Dower 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
Steve Dower 60419a7e96
bpo-37363: Add audit events for a range of modules (GH-14301) 2019-06-24 08:42:54 -07:00
Vinay Sajip ca7b504a4d
bpo-37111: Add 'encoding' and 'errors' parameters to logging.basicCon… (GH-14008) 2019-06-17 17:40:52 +01:00
Julien Palard 552951563c
Doc: Remove an ugly space before a dot. (GH-14123) 2019-06-16 10:25:05 +02:00
Julien Palard cfa0394b97 Doc: Deprecation header: More precise wording. (GH-14109) 2019-06-15 10:21:37 -04:00
Julien Palard 59e7bbcaa4 Doc: Python 3.9 in sidebar and version switcher. (GH-13824) 2019-06-04 19:15:32 -04:00
Łukasz Langa 9ab2fb1c68
Bump to 3.9.0a0 2019-06-04 22:12:32 +02:00
Łukasz Langa 3b5deb0116
Python 3.8.0b1 2019-06-04 19:44:34 +02:00
Julien Palard 46ed90dd01
Doc: Add an optional obsolete header. (GH-13638) 2019-05-29 18:34:04 +02:00
Matthias Bussonnier 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
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
Ned Deily 538f5c4786 Issue #27285: Cleanup "suspicious" warnings. 2016-07-11 14:21:58 -04:00
Martin Panter 590dcab95a Merge spelling fixes from 3.5 2016-06-20 07:55:14 +00:00
Martin Panter 2275e626b1 Fix spelling errors in code comments 2016-06-20 07:52:50 +00:00
Berker Peksag d1f534065c Merge from 3.5 2016-06-11 22:38:57 +03:00
Berker Peksag 326196047f Silence 'make suspicious' warnings 2016-06-11 22:38:33 +03:00
Martin Panter b198c42bcb Fix RST conflicts with Idle news entries 2016-06-08 13:32:49 +00:00
Martin Panter 37917369d5 Issue #23806: Merge susp-ignored.csv from 3.5 2016-04-24 04:07:58 +00:00
Martin Panter 887bc96e2e Issue #23806: Update susp-ignored.csv 2016-04-24 04:06:15 +00:00
Ezio Melotti 4c9375b65f #24918: merge with 3.5. 2016-03-13 11:41:45 +02:00
Ezio Melotti f2b9a39813 #24918: fix CSS for code blocks when a side box is present. Patch by Manvi B. 2016-03-13 11:41:05 +02:00
Berker Peksag 998f7d719b Issue #26246: Set initial value of the hidden attr when creating copy button.
Patch by Liang-Bo Wang.
2016-03-02 19:40:50 +02:00
Berker Peksag ff47cfbc66 Issue #26246: Set initial value of the hidden attr when creating copy button.
Patch by Liang-Bo Wang.
2016-03-02 19:40:30 +02:00
Berker Peksag 25c0ef518d Issue #26246: Set initial value of the hidden attr when creating copy button.
Patch by Liang-Bo Wang.
2016-03-02 19:40:08 +02:00
Georg Brandl d047c2f8b2 merge with 3.5 2016-02-28 21:13:44 +01:00
Georg Brandl 96421d6f11 Update susp-ignore file (#25910). 2016-02-28 21:13:23 +01:00
Ezio Melotti b8d75035f2 #26246: merge with 3.5. 2016-02-27 08:42:14 +02:00
Ezio Melotti 738f88f688 #26246: merge with 3.4. 2016-02-27 08:41:16 +02:00
Ezio Melotti 90ba2ca68a #26246: update copybutton.js after JQuery update. Patch by Liang-Bo Wang. 2016-02-27 08:39:36 +02:00
Georg Brandl 057ab49a6b merge with 3.5 2016-02-25 20:14:21 +01:00
Georg Brandl 2305b3cde3 Fix rstlint to also look for indented comments that should be directives. 2016-02-25 20:14:10 +01:00
Martin Panter 46988d3659 Merge string formatting doc fixes from 3.5 2016-02-08 01:49:35 +00:00
Martin Panter d5db14794b Issue #25179: Preparatory cleanup of existing docs on string formatting
* Various sections were pointing to the section on the string.Formatter
  class, when the section on the common format string syntax is probably more
  appropriate
* Fix references to various format() functions and methods
* Nested replacement fields may contain conversions and format specifiers,
  and this is tested; see Issue #19729 for instance
2016-02-08 01:34:09 +00:00
Victor Stinner bf980797af Merge 3.5 (i18n doc, issue #25907) 2016-01-22 18:00:31 +01:00
Victor Stinner 875f29aa69 doc: i18n HTML templates
Issue #25907: Use {% trans %} tags in HTML templates to ease the translation of
the documentation. The tag comes from Jinja templating system, used by Sphinx.

Patch written by Julien Palard.
2016-01-22 18:00:05 +01:00
Benjamin Peterson e45abae08f merge 3.5 (#26172) 2016-01-20 22:03:00 -08:00
Benjamin Peterson b57eaeadff merge 3.4 (#26172) 2016-01-20 22:02:47 -08:00
Benjamin Peterson c836f717cd remove script from epub (closes #26172) 2016-01-20 22:02:30 -08:00
Berker Peksag 2e7fca8e48 Issue #21240: Add an abstractmethod directive to mark abstract methods in the docs more explicitly 2015-12-08 12:15:19 +02:00
Berker Peksag 6e9d2e687b Issue #21240: Add an abstractmethod directive to mark abstract methods in the docs more explicitly 2015-12-08 12:14:50 +02:00
Berker Peksag a1331c4700 Silence a "unused rule" warning
This one should make Docs 3.5 and Docs 3.x green again.
2015-10-20 03:59:41 +03:00
Berker Peksag 1d1697930b Silence a "unused rule" warning
This one should make Docs 3.5 and Docs 3.x green again.
2015-10-20 03:59:24 +03:00
Berker Peksag 4b5d8018df Merge from 3.5
Hg: --
2015-10-02 23:29:13 +03:00
Berker Peksag 8214a7c38f Tweak susp-ignored.csv to make buildbots happy 2015-10-02 23:28:45 +03:00
Berker Peksag 9289e9038f Issue #25105: Update susp-ignored.csv to avoid false positives 2015-09-15 19:43:26 +03:00
Berker Peksag 055395eed2 Issue #25105: Update susp-ignored.csv to avoid false positives 2015-09-15 19:43:04 +03:00
Martin Panter b7ccb5d6c3 Issue #25022: Merge susp-ignored.csv from 3.5 2015-09-11 02:47:13 +00:00
Martin Panter 02918caeb8 Issue #25022: Merge susp-ignored.csv from 3.4 into 3.5 2015-09-11 02:46:54 +00:00
Martin Panter 91c03e090a Issue #25022: Avoid warning about unused suspicious rule 2015-09-11 02:45:10 +00:00
Martin Panter 015e3f65bc Issue #23406: Merge 3.5 into 3.6 2015-09-07 04:05:57 +00:00
Martin Panter 6cb196306a Issue #23406: Remove specific line number from susp-ignored.csv 2015-09-07 03:40:17 +00:00
Robert Collins 6afa84cfed Remove line numbers from unittest in susp-ignored. 2015-07-23 08:09:05 +12:00
Robert Collins 943ddac142 Remove line numbers from unittest in susp-ignored. 2015-07-23 08:08:59 +12:00
Robert Collins 80e4f30e64 Remove line numbers from unittest in susp-ignored. 2015-07-23 08:08:38 +12:00
Robert Collins cb4a6c1889 Merge unittest docs suspicious fix. 2015-07-23 07:32:39 +12:00
Robert Collins 6cd5635333 Merge unittest docs suspicious fix. 2015-07-23 07:32:27 +12:00
Robert Collins 16dd210543 Fix suspicious after the unittest docs change. 2015-07-23 07:07:07 +12:00
Zachary Ware cafc34fa3d Merge with 3.5 2015-07-21 22:50:54 -05:00
Zachary Ware d7841ef48b Merge with 3.4 2015-07-21 22:50:43 -05:00
Zachary Ware 4aa30dc275 rstlint: explicitly open files as UTF8 2015-07-21 22:50:29 -05:00
Zachary Ware 9f20bdb321 Merge 3.5 2015-07-07 00:34:37 -05:00
Zachary Ware 80d0651117 Update ignored suspicious markup 2015-07-07 00:34:25 -05:00
Zachary Ware 5c676f67d1 Fix suspicious markup 2015-07-06 23:27:15 -05:00
Ned Deily da2d51f97a merge 3.5.0b3 changes from 3.5 2015-07-05 11:17:43 -07:00
Larry Hastings aaa377f01d Documentation fixes for 3.5.0b3. 2015-07-04 19:11:41 -07:00
Larry Hastings 115b0da540 Change SOURCE_URI for pydoc source URLs to point back to correct branch for 3.6. 2015-05-30 17:28:56 -07:00
Benjamin Peterson d663cc4848 merge 3.4 2015-05-27 18:32:41 -05:00
Benjamin Peterson 68fe9aa58c update for 3.6 emerging 2015-05-27 18:32:25 -05:00
Larry Hastings 40040dfc4b Update SOURCE_URI to reflect that we're branching 3.5 now. 2015-05-23 17:41:13 -07:00
Larry Hastings 0482af4269 Updated topics (and susp-ignored) for Python 3.5.0b1. 2015-05-23 17:39:42 -07:00
Larry Hastings 770ce204ee Regenerated pydoc-topics and fixed bad/suspicious doc markup for Python 3.5.0a4. 2015-04-19 13:50:12 -07:00
Larry Hastings b2c2dc3643 Regenerated pydoc topics and minor doc fixes for 3.5.0a3. 2015-03-29 15:32:55 -07:00
Victor Stinner cbbdfb5933 Merge 3.4 (asyncio doc) 2015-02-17 23:11:56 +01:00
Victor Stinner e170ed27c6 asyncio doc: fix the sphinx extension for coroutine commands 2015-02-17 23:08:35 +01:00
Victor Stinner 866ca88f2d Merge 3.4 (asyncio doc) 2015-02-12 22:49:45 +01:00
Victor Stinner bdd574d09a asyncio doc: annotate coroutine on coroutine functions and methods 2015-02-12 22:49:18 +01:00
Berker Peksag bf764a1912 Issue #22695: Fix rendering of the deprecated-removed role in HTML. 2014-11-08 22:41:00 +02:00
Berker Peksag eb1a3cd4ea Issue #22695: Fix rendering of the deprecated-removed role in HTML. 2014-11-08 22:40:22 +02:00
Georg Brandl db3f318681 Doc: updadate suspicious ignore rules 2014-10-31 08:03:20 +01:00
Georg Brandl e075f1617f merge with 3.4 2014-10-30 22:56:04 +01:00
Georg Brandl 35903c809f Sphinx extension: move imports to the module top 2014-10-30 22:55:13 +01:00
Georg Brandl 55c2ae8cb1 merge with 3.4 2014-10-30 22:50:00 +01:00
Georg Brandl 3b4cf554e5 rstlint: make the "html leaked markup" regex a bit less sensitive 2014-10-30 22:49:54 +01:00
Georg Brandl 9ac894aeff merge with 3.4 2014-10-30 22:45:01 +01:00
Georg Brandl 2273b096ce rstlint: we do not use svn anymore 2014-10-30 22:44:41 +01:00
Georg Brandl 759a02cacd merge with 3.4 2014-10-30 22:35:59 +01:00
Georg Brandl 95988f98ea rstlint: add more directives we use 2014-10-30 22:35:55 +01:00
Georg Brandl dd6b84d715 merge with 3.4 2014-10-30 22:31:08 +01:00
Georg Brandl f2b56518f9 rstlint: recognize "deprecated-removed" directive 2014-10-30 22:30:01 +01:00
Georg Brandl cadc3fdcb5 Merge with 3.4 2014-10-29 08:37:29 +01:00
Georg Brandl e73778c1ac Use https:// URLs when referring to python.org hosts. 2014-10-29 08:36:35 +01:00
Georg Brandl 46761ec7c2 Use https:// URLs in the HTML templates. 2014-10-29 08:36:15 +01:00
Georg Brandl 76c49a2fb9 merge with 3.4 2014-10-29 08:11:55 +01:00
Georg Brandl a1f8486325 Move HTML templates to their own subdir. 2014-10-29 08:11:46 +01:00
Georg Brandl d51c1a1953 merge with 3.4 2014-10-29 08:07:50 +01:00
Georg Brandl e03902910c Move Sphinx extensions to their own subdir. 2014-10-29 08:07:37 +01:00
Berker Peksag 8625dde150 Issue #22723: Make link styling more accessible.
Patch by Buck Golemon.
2014-10-25 05:21:17 +03:00
Berker Peksag 6d1c149a46 Issue #22723: Make link styling more accessible.
Patch by Buck Golemon.
2014-10-25 05:20:49 +03:00
Alex Gaynor e6f8c5025a Use https:// URLs for the bug tracker in the :issue: role.
Thanks to Ezio for noticing this
2014-10-13 12:58:03 -07:00
Alex Gaynor e285cdd997 Use https:// URLs for the bug tracker in the :issue: role.
Thanks to Ezio for noticing this
2014-10-13 12:58:03 -07:00
Larry Hastings 2ce95d7b7c Merge from 3.4.2 release head back into 3.4 mainline. 2014-10-08 02:50:50 -07:00
Larry Hastings c6256e5f7d Update pydoc topics and fix supsicious markup for 3.4.2 final. 2014-10-05 19:03:48 -07:00
Georg Brandl f7b2aa514e merge with 3.4 2014-10-01 19:42:09 +02:00
Georg Brandl 0428e6cc89 Remove old overridden version of a Sphinx CSS file.
All Python-specific styling is now in the theme anyway.
2014-10-01 19:41:31 +02:00
Georg Brandl 42c189efe4 merge with 3.4 2014-10-01 19:28:33 +02:00
Georg Brandl fd3a15a0cc Make pydoctheme compatible with Sphinx 1.3 HTML output changes. 2014-10-01 19:28:23 +02:00
Georg Brandl 61bd1dcf9b Move Doc/tools/sphinxext content to Doc/tools, there is no need for the nested subdirectory anymore. 2014-09-30 22:56:38 +02:00
Georg Brandl 97e9ec688c Move Doc/tools/sphinxext content to Doc/tools, there is no need for the nested subdirectory anymore. 2014-09-30 22:51:30 +02:00
Georg Brandl 7552eb89b9 merge with 3.4 2014-09-30 22:17:48 +02:00
Georg Brandl bae334cda9 Prepare sphinx extensions for 1.3. 2014-09-30 22:17:41 +02:00
Ned Deily b682fd3dbb Issue #21431: merge from 3.4 2014-09-22 14:44:22 -07:00
Georg Brandl 90d76ca765 Closes #21431: make docs depend on Sphinx 1.2 and fix pydoc-topics builder to
return Unicode strings on Python 3.
2014-09-22 21:18:24 +02:00
Benjamin Peterson 50ff85812f merge 3.4 2014-09-13 01:45:50 -04:00
Benjamin Peterson 7c8b89e156 make hg link secure 2014-09-13 01:44:34 -04:00
Berker Peksag adc5634193 Issue #22150: Fix deprecated-removed directive in Sphinx 1.2. 2014-08-22 18:25:16 +03:00
Berker Peksag eb265ab873 Issue #22150: Fix deprecated-removed directive in Sphinx 1.2. 2014-08-22 18:24:29 +03:00
Senthil Kumaran 6120ab8150 merge from 3.4
Update references to Python docs in the sidebar index.
Patch contributed by Auke Willem Oosterhoff.
2014-06-02 23:00:43 -07:00
Senthil Kumaran 8dc3df1b60 Update references to Python docs in the sidebar index.
Patch contributed by Auke Willem Oosterhoff.
2014-06-02 22:58:13 -07:00
Benjamin Peterson d065c48991 fix ref count annotations on sphinx >= 1.2.1 (closes #21286) 2014-04-17 18:29:01 -04:00
Benjamin Peterson af7c5b0bb5 merge 3.4 2014-04-17 18:29:27 -04:00
Georg Brandl aa1403c440 merge with 3.4 2014-03-28 19:49:02 +01:00
Georg Brandl 865bdbf4af Doc: do not compress .epub for dist, it is already zipped. 2014-03-28 19:48:55 +01:00
Georg Brandl b50f8c9c0d merge with 3.4 2014-03-25 10:13:44 +01:00
Georg Brandl 1afe2af690 Closes #21045: make the Qt help build not look completely stupid 2014-03-25 10:12:47 +01:00
Georg Brandl 3f2350c647 merge with 3.4 2014-03-18 07:47:35 +01:00
Georg Brandl 3a748ca982 merge with 3.4 2014-03-17 07:36:59 +01:00
Georg Brandl a7f48019d5 merge with 3.3 2014-03-17 07:36:51 +01:00
Georg Brandl 56d3a03f70 Update doc version switcher for 3.4/3.5. 2014-03-17 07:36:45 +01:00
Larry Hastings 3c5c56f3c0 Merged default into 3.4 branch. 3.4 branch is now effectively 3.4.1rc1. 2014-03-16 22:54:05 -07:00
Larry Hastings cf1a3cd2c7 Release bump for 3.4.0 final. 2014-03-15 22:34:24 -07:00
Larry Hastings 0548f5c514 Regenerate pydoc_topics, fix markup errors, in preparation for 3.4.0 final. 2014-03-15 22:29:19 -07:00
Larry Hastings 3732ed2414 Merge in all documentation changes since branching 3.4.0rc1. 2014-03-15 21:13:56 -07:00
Nick Coghlan f7614d55a2 Close #19407: New installation & distribution guides
- based on pip and other PyPA tools
- includes references to the new Python Packaging User Guide
  where appropriate (and the relevant section is at least
  partially filled in)
- started new FAQ sections
- both guides aim to introduce users to basic open source
  concepts if they aren't aware of them
- existing guides have been relocated (now linked from the
  distutils docs) rather then removed, since there is
  some needed material that has yet to be relocated to the
  distutils docs as a reference for the legacy formats
2014-03-13 22:13:45 +10:00
Georg Brandl 18a364fc3d Closes #20090: update Doc/README and the error message in sphinx-build.py to make
it clear that any Python 3.x is not usable with the checked out Sphinx.
2014-03-10 19:26:57 +01:00