summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorVictor Stinner <vstinner@python.org>2020-09-18 15:21:24 (GMT)
committerGitHub <noreply@github.com>2020-09-18 15:21:24 (GMT)
commit3acc403f21642f1e916f035abf24c3fb81495b3c (patch)
tree99c3e7890e68e117afcc0106c0480175e7a01aa7 /Doc
parentb7cdea8f087699aaa6486ce5a4f6e5a143dc355e (diff)
downloadcpython-3acc403f21642f1e916f035abf24c3fb81495b3c.zip
cpython-3acc403f21642f1e916f035abf24c3fb81495b3c.tar.gz
cpython-3acc403f21642f1e916f035abf24c3fb81495b3c.tar.bz2
bpo-35293: Travis CI uses "make venv" for the doc (GH-22307) (GH-22309) (GH-22310)
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) (cherry picked from commit 9e73cac173e5e9010bd18c8334fffeee1cade3a4)
Diffstat (limited to 'Doc')
-rw-r--r--Doc/Makefile2
-rw-r--r--Doc/requirements.txt12
2 files changed, 13 insertions, 1 deletions
diff --git a/Doc/Makefile b/Doc/Makefile
index b8ca1ed..f653d70 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
new file mode 100644
index 0000000..47b78ee
--- /dev/null
+++ b/Doc/requirements.txt
@@ -0,0 +1,12 @@
+# 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