Commit Graph

372 Commits

Author SHA1 Message Date
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