bpo-35293: Travis CI uses "make venv" for the doc (GH-22307)

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
This commit is contained in:
Victor Stinner 2020-09-18 16:23:18 +02:00 committed by GitHub
parent 6595cb0af4
commit 8394500cca
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 12 additions and 8 deletions

View File

@ -51,10 +51,7 @@ matrix:
env: TESTING=docs env: TESTING=docs
before_script: before_script:
- cd Doc - cd Doc
# Sphinx is pinned so that new versions that introduce new warnings won't suddenly cause build failures. - make venv PYTHON=python
# (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
script: script:
- make check suspicious html SPHINXOPTS="-q -W -j4" - make check suspicious html SPHINXOPTS="-q -W -j4"
- name: "Documentation tests" - name: "Documentation tests"

View File

@ -143,7 +143,7 @@ clean:
venv: venv:
$(PYTHON) -m venv $(VENVDIR) $(PYTHON) -m venv $(VENVDIR)
$(VENVDIR)/bin/python3 -m pip install -U pip setuptools $(VENVDIR)/bin/python3 -m pip install -U pip setuptools
$(VENVDIR)/bin/python3 -m pip install -U Sphinx==3.2.1 blurb python-docs-theme $(VENVDIR)/bin/python3 -m pip install -r requirements.txt
@echo "The venv has been created in the $(VENVDIR) directory" @echo "The venv has been created in the $(VENVDIR) directory"
dist: dist:

View File

@ -1,5 +1,12 @@
# Requirements for docs build on netlify # Requirements to build the Python documentation
# Pin sphinx to version specified in .travis.yml
sphinx==2.2.0 # 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==3.2.1
blurb blurb
# The theme used by the documentation is stored separately, so we need
# to install that as well.
python-docs-theme python-docs-theme