diff options
| author | Victor Stinner <vstinner@python.org> | 2020-09-18 16:53:46 +0200 |
|---|---|---|
| committer | Łukasz Langa <lukasz@langa.pl> | 2020-10-04 17:30:48 +0200 |
| commit | f8b3c64958753abce7badbff3525863577fe2e04 (patch) | |
| tree | 4922d73821747c575686e0bd9eb426dc26d9127d | |
| parent | e5cc5fd89cc8855ad644ce4ba5e7de766313e418 (diff) | |
| download | cpython-git-f8b3c64958753abce7badbff3525863577fe2e04.tar.gz | |
bpo-35293: Travis CI uses "make venv" for the doc (GH-22307) (GH-22309)
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
* Update Sphinx to version 2.4.4
(cherry picked from commit 8394500cca56490cc347604d39ca40abcdce46c3)
| -rw-r--r-- | .travis.yml | 5 | ||||
| -rw-r--r-- | Doc/Makefile | 2 | ||||
| -rw-r--r-- | Doc/requirements.txt | 13 |
3 files changed, 12 insertions, 8 deletions
diff --git a/.travis.yml b/.travis.yml index e565f49262..5d9f4208e0 100644 --- a/.travis.yml +++ b/.travis.yml @@ -51,10 +51,7 @@ matrix: env: TESTING=docs before_script: - cd Doc - # Sphinx is pinned so that new versions that introduce new warnings won't suddenly cause build failures. - # (Updating the version is fine as long as no warnings are raised by doing so.) - # The theme used by the docs is stored separately, so we need to install that as well. - - python -m pip install sphinx==2.2.0 blurb python-docs-theme + - make venv PYTHON=python script: - make check suspicious html SPHINXOPTS="-q -W -j4" - name: "Documentation tests" diff --git a/Doc/Makefile b/Doc/Makefile index b8ca1edfbc..f653d70674 100644 --- a/Doc/Makefile +++ b/Doc/Makefile @@ -143,7 +143,7 @@ clean: venv: $(PYTHON) -m venv $(VENVDIR) $(VENVDIR)/bin/python3 -m pip install -U pip setuptools - $(VENVDIR)/bin/python3 -m pip install -U Sphinx==2.3.1 blurb python-docs-theme + $(VENVDIR)/bin/python3 -m pip install -r requirements.txt @echo "The venv has been created in the $(VENVDIR) directory" dist: diff --git a/Doc/requirements.txt b/Doc/requirements.txt index 198446b350..47b78eeac8 100644 --- a/Doc/requirements.txt +++ b/Doc/requirements.txt @@ -1,5 +1,12 @@ -# Requirements for docs build on netlify -# Pin sphinx to version specified in .travis.yml -sphinx==2.2.0 +# Requirements to build the Python documentation + +# Sphinx version is pinned so that new versions that introduce new warnings +# won't suddenly cause build failures. Updating the version is fine as long +# as no warnings are raised by doing so. +sphinx==2.4.4 + blurb + +# The theme used by the documentation is stored separately, so we need +# to install that as well. python-docs-theme |