361 Commits

Author SHA1 Message Date
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
Mariatta
814213bdf1 [3.6] Backport README.rst changes (GH-294)
(cherry picked from commit b3f1f59cf4)
(cherry picked from commit 1b3d88eb33)
(cherry picked from commit c0866855d5)
(cherry picked from commit e32ec9334b)
(cherry picked from commit 6329aea78e)
2017-02-25 11:56:48 -08:00
Victor Stinner
b300c660d3 Backport36 doc fixes: PR#68 and PR#124 (#125)
* Travis CI: run rstlint.py in the docs job (#68)

Currently, http://buildbot.python.org/all/buildslaves/ware-docs
buildbot is only run as post-commit. For example, bpo-29521 (PR#41)
introduced two warnings, unnotified by the Travis CI docs job.

Modify the docs job to run toosl/rstlint.py.

Fix also the two minor warnings which causes the buildbot slave to
fail.
(cherry picked from commit 2b501866ed)

* 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.

(cherry picked from commit 91b0e7d0ca)
2017-02-16 00:56:54 +01:00
Mariatta
9268855ba6 Fix some sphinx warnings (#9) (#81)
* Fix some deprecation warnings in Doc/conf.py
* Fix an rst error in Misc/NEWS

Contributed by Ryan Gonzalez @kirbyfan64

(cherry picked from commit e7ffb99f84)
2017-02-14 06:11:48 -08:00
Victor Stinner
33bb64fb30 Merge 3.5 2016-10-18 15:48:14 +02:00
Victor Stinner
9f2e377beb 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