Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity
105,228 Commits 6 Branches 593 Tags 2.8 GiB
Commit Graph

373 Commits

Author SHA1 Message Date
Jean-François B b5381f6697 bpo-34293: Fix PDF documentation paper size (GH-8585) 
The "A4" pdfs were previously the wrong size due to a change in the options in Sphinx 1.5.

See also sphinx-doc/sphinx#5235
 2019-09-09 22:52:03 +01:00
Julien Palard 7d23dbe6d1
Doc: Bump Sphinx verison. (#13785) 
To reflect the one we're using in production.
 2019-06-15 15:41:58 +02:00
Stéphane Wirtel 0a52d73dde Doc: Update pip and setuptools when creating the virtual environment (GH-13307) 
Add a new pip install before `sphinx` etc.. because we should use the last version of `pip` and `setuptools`
 2019-05-14 04:49:49 -07:00
Gregory P. Smith 3918ad6b45
bpo-36838: Suggest 'make venv' when missing Doc/ tools. (GH-13173) 2019-05-07 17:03:50 -04:00
Stéphane Wirtel 09a9f1799c bpo-36329: Declare the version of Python to use for Tools/scripts/serve.py (#12385) 
* bpo-36329: Declare the version of Python to use for Tools/scripts/serve.py

* Add the blurb entry
 2019-03-18 11:47:55 +01:00
Julien Palard f98c1623ec
Doc: -W flag for sphinx-build can be disabled (GH-10303) 2018-11-03 19:06:33 +01:00
Xtreak 121eb1694c bpo-34081: Fix wrong example link that was linking to distutils (GH-8248) 2018-10-21 16:54:52 +02:00
Jon Wayne Parrott bf63e8d55f bpo-30607: Use external python-doc-theme (GH-2017) 2018-03-01 16:02:50 -05:00
Ned Deily 122fc136b3
Revert "bpo-30487: automatically create a venv and install Sphinx when running make (GH-4346)" (#4592) 
Fix breakage documented in bpo-32149.
This reverts commit d8d6b91221.
 2017-11-27 17:07:32 -05:00
Caleb Hattingh d8d6b91221 bpo-30487: automatically create a venv and install Sphinx when running make (GH-4346) 2017-11-26 15:18:30 -06:00
Ned Deily 590665c399 bpo-31036: Allow sphinx and blurb to be found automatically (#3440) 
Rather than requiring the path to blurb and/or sphinx-build to be specified to the make rule, enhance the Doc/Makefile to look for each first in a virtual environment created by make venv and, if not found, look on the normal process PATH. This allows the Doc/Makefile to take advantage of an installed spinx-build or blurb and, thus, do the right thing most of the time. Also, make the directory for the venv be configurable and document the `make venv` target.
 2017-09-07 17:17:53 -07:00
Ned Deily fcd97d4438 Include additional changes to support blurbified NEWS (#3340) 2017-09-05 00:46:18 -07: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
Nick Coghlan 7a82f9c2b9 bpo-30052: Always regenerate cross-references (#1339) 
* bpo-30052: Always regenerate cross-references

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.
 2017-06-02 23:30:57 +10:00
Roger b3f1f59cf4 Rename Doc/README.txt to Doc/README.rst and add formatting (#104) 
* Reformat Doc/README.txt to Doc/README.rst

* Update mention of Doc/README.rst

* Update mention of README.txt to README.rst

* Make line fold

* rstlint ignore Doc/README.rst

* conf.py ignore Doc/README.rst

* Update issue tracker url in Docs/README.rst
 2017-02-15 23:54:05 +01:00
Victor Stinner 91b0e7d0ca Doc/Makefile: set PYTHON to python3 (#124) 
rstlint.py run by "make check" doesn't support Python 2.

"make venv" runs "$(PYTHON) -m venv", whereas Python 2 doens't
provide the venv module: it's a module of Python 3 standard library.
 2017-02-15 23:36:08 +01:00
Ryan Gonzalez e7ffb99f84 Fix some sphinx warnings (#9) 
* Fix some deprecation warnings in Doc/conf.py
* Fix an rst error in Misc/NEWS
 2017-02-11 13:47:37 +09:00
Victor Stinner 57acb82d27 Issue #27896: Allow passing sphinx options to Doc/Makefile 
Patch written by Julien Palard.
 2016-10-16 19:14:23 +02:00
Georg Brandl d20cb0263a merge with 3.5 2016-06-15 08:58:46 +02:00
Georg Brandl b14f0c6409 merge with 3.4 2016-06-15 08:58:00 +02:00
Georg Brandl 4b9e75ba7f Docs: add html-stable autobuild variant 2016-06-15 08:57:32 +02:00
Zachary Ware bfba2cd406 Don't doc check the venv dir 2016-03-24 22:44:41 -05:00
Larry Hastings e8ff0caa72 Regenerated pydoc topic index in preparation for Python 3.5.0b2. 2015-05-30 16:58:27 -07:00
Benjamin Peterson 649e1f141a merge 3.4 2014-12-10 11:05:35 -05:00
Benjamin Peterson 82c05a54a2 fix path to patchlevel.py 2014-12-10 11:04:17 -05:00
Brett Cannon d5ea39d1b8 Issue #22394: Add a 'venv' command to Doc/Makefile. 
This will create a venv using the interpreter specified by the PYTHON
variable for the Makefile that also install Sphinx. Typical usage is
expected to be:

  cd Doc
  make venv PYTHON=../python
  make html PYTHON=venv/bin/python3
 2014-12-05 15:17:31 -05: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 2b1a0a30c9 Dont define an empty SPHINXOPTS, which overrides a definition from the environment. 2014-09-30 22:23:57 +02:00
Benjamin Peterson efd713b82b allow archives for rc releases to be built (closes #22484) 2014-09-24 20:22:24 -04: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
Serhiy Storchaka 17f5f817de Issue #15759: "make suspicious", "make linkcheck" and "make doctest" in Doc/ 
now display special message when and only when there are failures.
 2014-07-22 10:24:25 +03:00
Zachary Ware 9393fffa5f Issue #17386: List the 'htmlview' target in the Doc/Makefile help output. 2014-04-29 09:24:40 -05:00
Georg Brandl 865bdbf4af Doc: do not compress .epub for dist, it is already zipped. 2014-03-28 19:48:55 +01:00
Éric Araujo f446d7a70b Remove references to make targets deleted in eef7899ea7ab 2014-03-13 19:30:43 -04:00
Georg Brandl f7b2f36f74 Doc: do not rely on checked-out Sphinx toolchain from svn.python.org anymore 
Nowadays it is likely that people will have Sphinx installed,
and if not, they will know how to install it.

This also simplifies life a lot for distribution packagers,
who typically do not want the doc build process to connect
to external web resources.
 2014-02-16 09:46:36 +01:00
Georg Brandl 8bd656ddb8 Closes #20258: Sphinx toolchain: move back to Jinja2 2.3.1 with support for Py2.5. 2014-01-14 12:00:45 +01:00
Georg Brandl 5636eb7b93 Update Sphinx toolchain. 2014-01-11 20:04:19 +01:00
Georg Brandl 44d2429a25 Doc/Makefile: also do "make suspicious" during daily autobuild 2013-11-24 16:17:54 +01:00
Georg Brandl 01f47e82a3 Add a autobuild-quick target that only rebuilds HTML. 2012-10-28 08:09:02 +01:00
Ezio Melotti fe71bb52e4 #8040: merge with 3.2. 2012-10-27 22:29:50 +03:00
Ezio Melotti 58864b3cad #8040: enable the versionswitcher for the autobuild-dev target. 2012-10-27 22:28:48 +03:00
Georg Brandl 0472bc8709 Use newer version of Pygments that handles "yield from". 2012-09-30 18:00:50 +02:00
Georg Brandl 7f3cd98beb Fix target path in message. 2011-07-03 09:30:42 +02:00
Georg Brandl 6dc50f34dd Update to 1.0.7. 2011-01-15 16:45:03 +00:00
Georg Brandl 183fe81f8f #10130: Prepare for building epub-format docs. 2011-01-05 11:00:25 +00:00
Georg Brandl cfa8e29d1c Switch to Sphinx 1.0.5. 2010-11-12 08:09:11 +00:00
Georg Brandl 5ad8ed5f26 Update to Sphin 1.0.4. 2010-10-06 12:29:49 +00:00
Georg Brandl 19b3e00627 Fix the suspicious builder not to write CRLF, update suspicious file and add instructions to Makefile. 2010-10-06 10:35:24 +00:00
Éric Araujo 716ac385d9 Revert accidental commit, apologies for the noise 2010-09-06 01:31:11 +00:00
Éric Araujo f63a6fc24e Update 2010-09-06 01:27:06 +00:00