summaryrefslogtreecommitdiffstats
path: root/Doc/Makefile
Commit message (Collapse)AuthorAgeFilesLines
* Add JOBS parameter to docs Makefile (GH-101395)Miss Islington (bot)2023-01-311-1/+2
| | | | | (cherry picked from commit 1a62ae84c687791bc1dfb54d1eb75e1c7277bb04) Co-authored-by: Christophe Nanteuil <35002064+christopheNan@users.noreply.github.com>
* Speedup: build docs in parallel (GH-92733) (GH-92850)Hugo van Kemenade2022-05-161-1/+1
| | | (cherry picked from commit a487623c6b784847a8a1e47b4597b0ae2b8def87)
* bpo-44756: [docs] revert automated virtual environment creation on `make ↵Miss Islington (bot)2021-08-061-2/+3
| | | | | | | | html` (GH-27635) It turned out to be disruptive for downstream distributors. (cherry picked from commit 55fa87b1ef46bbb9db7612b2dc2dd7fb039d9bc3) Co-authored-by: Łukasz Langa <lukasz@langa.pl>
* bpo-44756: in ./Doc, `make build` depends on `make html` (GH-27403) (GH-27410)Miss Islington (bot)2021-07-281-7/+14
| | | | | | | - venv rule is now conditional, and only does anything if $VENVDIR does not exist - add rule "clean-venv" (cherry picked from commit d22c876d5ac5fa464337d2e82654b8d87a83cb1b) Co-authored-by: Jack DeVries <58614260+jdevries3133@users.noreply.github.com>
* bpo-42238: Check Misc/NEWS.d/next/ for reStructuredText issues. (GH-23802)Julien Palard2020-12-181-0/+1
|
* bpo-42238: Doc: Remove make suspicious from the CI and docs builds. (GH-23313)Julien Palard2020-11-251-1/+0
| | | | | It probably helped a lot a while back, but may not be as usefull today. We'll continue monitoring it before deletion, so true positives can be migrated to rstlint.
* bpo-41028: Doc: Move switchers to docsbuild-scripts. (GH-20969)Julien Palard2020-11-071-2/+2
|
* bpo-35293: Travis CI uses "make venv" for the doc (GH-22307)Victor Stinner2020-09-181-1/+1
| | | | | | | Doc/requirements.txt becomes the reference for packages and package versions needed to build the Python documentation. * Doc/Makefile now uses Doc/requirements.txt * .travis.yml now uses "make env" of Doc/Makefile
* bpo-41685: Don't pin setuptools version anymore in Doc/Makefile (GH-22062)Victor Stinner2020-09-021-2/+1
| | | | setuptools 50.0.2 is now compatible with Python 3.10: https://github.com/pypa/setuptools/pull/2361
* bpo-40204: Update Sphinx to version 3.2.1 in Doc/Makefile (GH-22043)Victor Stinner2020-09-021-1/+1
|
* bpo-41685: Temporarily pin setuptools to 49.2.1 in Docs venv. (GH-22038)Ned Deily2020-09-011-1/+2
| | | See https://github.com/pypa/setuptools/pull/2361
* bpo-40204: Pin Sphinx version to 2.3.1 in ``Doc/Makefile``. (GH-21141)Ned Deily2020-06-251-1/+1
|
* Bump Sphinx to 2.2.0. (GH-16532)Julien Palard2019-10-221-1/+1
|
* bpo-37504: Fix documentation build with texinfo builder (GH-14606)Dmitry Shachnev2019-09-101-1/+18
| | | | | | | | | 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
* bpo-34293: Fix PDF documentation paper size (GH-8585)Jean-François B2019-09-091-1/+5
| | | | | 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
* Doc: Bump Sphinx verison. (#13785)Julien Palard2019-06-151-1/+1
| | | To reflect the one we're using in production.
* Doc: Update pip and setuptools when creating the virtual environment (GH-13307)Stéphane Wirtel2019-05-141-0/+1
| | | Add a new pip install before `sphinx` etc.. because we should use the last version of `pip` and `setuptools`
* bpo-36838: Suggest 'make venv' when missing Doc/ tools. (GH-13173)Gregory P. Smith2019-05-071-4/+12
|
* bpo-36329: Declare the version of Python to use for Tools/scripts/serve.py ↵Stéphane Wirtel2019-03-181-1/+1
| | | | | | | | (#12385) * bpo-36329: Declare the version of Python to use for Tools/scripts/serve.py * Add the blurb entry
* Doc: -W flag for sphinx-build can be disabled (GH-10303)Julien Palard2018-11-031-2/+3
|
* bpo-34081: Fix wrong example link that was linking to distutils (GH-8248)Xtreak2018-10-211-1/+1
|
* bpo-30607: Use external python-doc-theme (GH-2017)Jon Wayne Parrott2018-03-011-1/+1
|
* Revert "bpo-30487: automatically create a venv and install Sphinx when ↵Ned Deily2017-11-271-7/+5
| | | | | | running make (GH-4346)" (#4592) Fix breakage documented in bpo-32149. This reverts commit d8d6b9122134f040cd5a4f15f40f6c9e3386db4d.
* bpo-30487: automatically create a venv and install Sphinx when running make ↵Caleb Hattingh2017-11-261-5/+7
| | | | (GH-4346)
* bpo-31036: Allow sphinx and blurb to be found automatically (#3440)Ned Deily2017-09-081-6/+8
| | | | 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.
* Include additional changes to support blurbified NEWS (#3340)Ned Deily2017-09-051-1/+16
|
* bpo-31045: Language switch (#2652)Julien2017-08-071-2/+2
| | | | | | | | | | | | | | | | | | * 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.
* bpo-30052: Always regenerate cross-references (#1339)Nick Coghlan2017-06-021-2/+7
| | | | | | | | | | | | | * 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.
* Rename Doc/README.txt to Doc/README.rst and add formatting (#104)Roger2017-02-151-1/+1
| | | | | | | | | | | | | | | | * 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
* Doc/Makefile: set PYTHON to python3 (#124)Victor Stinner2017-02-151-1/+1
| | | | | | 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.
* Fix some sphinx warnings (#9)Ryan Gonzalez2017-02-111-1/+1
| | | | * Fix some deprecation warnings in Doc/conf.py * Fix an rst error in Misc/NEWS
* Issue #27896: Allow passing sphinx options to Doc/MakefileVictor Stinner2016-10-161-2/+2
| | | | Patch written by Julien Palard.
* merge with 3.5Georg Brandl2016-06-151-1/+8
|\
| * merge with 3.4Georg Brandl2016-06-151-1/+8
| |\
| | * Docs: add html-stable autobuild variantGeorg Brandl2016-06-151-1/+7
| | |
* | | Don't doc check the venv dirZachary Ware2016-03-251-1/+1
|/ /
* | Regenerated pydoc topic index in preparation for Python 3.5.0b2.Larry Hastings2015-05-301-2/+2
| |
* | merge 3.4Benjamin Peterson2014-12-101-1/+1
|\ \ | |/
| * fix path to patchlevel.pyBenjamin Peterson2014-12-101-1/+1
| |
| * Move Doc/tools/sphinxext content to Doc/tools, there is no need for the ↵Georg Brandl2014-09-301-2/+2
| | | | | | | | nested subdirectory anymore.
* | Issue #22394: Add a 'venv' command to Doc/Makefile.Brett Cannon2014-12-051-3/+7
| | | | | | | | | | | | | | | | | | | | 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
* | Move Doc/tools/sphinxext content to Doc/tools, there is no need for the ↵Georg Brandl2014-09-301-2/+2
|/ | | | nested subdirectory anymore.
* Dont define an empty SPHINXOPTS, which overrides a definition from the ↵Georg Brandl2014-09-301-1/+0
| | | | environment.
* allow archives for rc releases to be built (closes #22484)Benjamin Peterson2014-09-251-2/+3
|
* Issue #15759: "make suspicious", "make linkcheck" and "make doctest" in Doc/Serhiy Storchaka2014-07-221-10/+16
| | | | now display special message when and only when there are failures.
* Issue #17386: List the 'htmlview' target in the Doc/Makefile help output.Zachary Ware2014-04-291-0/+1
|
* Doc: do not compress .epub for dist, it is already zipped.Georg Brandl2014-03-281-8/+2
|
* Remove references to make targets deleted in eef7899ea7abÉric Araujo2014-03-131-3/+2
|
* Doc: do not rely on checked-out Sphinx toolchain from svn.python.org anymoreGeorg Brandl2014-02-161-29/+2
| | | | | | | | | 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.
* Closes #20258: Sphinx toolchain: move back to Jinja2 2.3.1 with support for ↵Georg Brandl2014-01-141-1/+1
| | | | Py2.5.