on master help sign in
[fix] Update Sphinx package versions

* Update call to sphinx-autobuild (remove --poll -B options, add --open-browser) * Upgrade the Sphinx and sphinx-tabs versions. * utils/makefile.sphinx: remove the SPHINXVERS variable. * utils/makefile.sphinx: remove the sphinx-doc and sphinx-live targets, Sphinx is already installed by the pyenvinstall target.

commitc2a6f145160dca0873dbd2f2c9ffe7e1bc340236 authorAlexandre Flament <alex@al-f.net> dateSun 20 Sep 2020, 07:51 (6 years ago) parent9d60ae1
3 files changed+9−33
Makefile+2−2 requirements-dev.txt+6−2 utils/makefile.sphinx+1−29
Makefile+2−2
@@ -80,11 +80,11 @@ run: buildenv pyenvinstall
8080sphinx-doc-prebuilds:: buildenv pyenvinstall prebuild-includes
8181
8282PHONY += docs
83−docs: sphinx-doc-prebuilds sphinx-doc
83+docs: sphinx-doc-prebuilds
8484 $(call cmd,sphinx,html,docs,docs)
8585
8686PHONY += docs-live
87−docs-live: sphinx-doc-prebuilds sphinx-live
87+docs-live: sphinx-doc-prebuilds
8888 $(call cmd,sphinx_autobuild,html,docs,docs)
8989
9090PHONY += prebuild-includes
requirements-dev.txt+6−2
@@ -12,9 +12,13 @@ selenium==3.141.0
1212twine==3.2.0; python_version >= "3.6"
1313twine==1.15.0; python_version < "3.6"
1414Pallets-Sphinx-Themes==1.2.3
15−Sphinx==3.0.1
15+Sphinx==3.2.1; python_version >= '3.6'
16+Sphinx==3.0.1; python_version < '3.6'
1617sphinx-issues==1.2.0
1718sphinx-jinja==1.1.1
18−sphinx-tabs==1.1.13
19+sphinx-tabs==1.3.0; python_version >= '3.6'
20+sphinx-tabs==1.1.13; python_version < '3.6'
1921sphinxcontrib-programoutput==0.16
22+sphinx-autobuild==2020.9.1; python_version >= '3.6'
23+sphinx-autobuild==0.7.1; python_version < '3.6'
2024linuxdoc @ git+http://github.com/return42/linuxdoc.git@70673dcf69e705e08d81f53794895dc15c4920b3#egg=linuxdoc
utils/makefile.sphinx+1−29
@@ -21,23 +21,6 @@ else
2121 SPHINX_VERBOSE =
2222endif
2323
24−## SPHINXVERS variable
25−## ===================
26−##
27−## .. _requirement-specifiers: https://pip.pypa.io/en/stable/reference/pip_install/#requirement-specifiers
28−##
29−## Sphinx version to use, when building documentation. Set this when calling
30−## build target. The default value is empty (install latest), to select a
31−## specific version use a requirement-specifiers_. E.g. to build your target
32−## 'doc' with a select sphinx-doc_ version 1.7.9::
33−##
34−## make SPHINXVERS='==1.7.9' docs
35−##
36−## To build with latest 1.7::
37−##
38−## make SPHINXVERS='>=1.7,<1.8' docs
39−##
40−SPHINXVERS ?=
4124
4225docs-help:
4326 @echo 'makefile.sphinx:'
@@ -56,17 +39,6 @@ docs-help:
5639# requirements
5740# ------------------------------------------------------------------------------
5841
59−sphinx-doc-prebuilds:: $(PY_ENV)
60−
61−sphinx-doc: sphinx-doc-prebuilds
62− @echo "PYENV installing Sphinx$(SPHINXVERS)"
63− $(Q)$(PY_ENV_BIN)/pip install $(PIP_VERBOSE) 'Sphinx$(SPHINXVERS)'
64−
65−sphinx-live: sphinx-doc-prebuilds
66− @echo "PYENV installing Sphinx$(SPHINXVERS)"
67− $(Q)$(PY_ENV_BIN)/pip install $(PIP_VERBOSE) 'Sphinx$(SPHINXVERS)' sphinx-autobuild
68−
69−
7042PHONY += msg-texlive texlive
7143
7244ifeq ($(shell which xelatex >/dev/null 2>&1; echo $$?), 1)
@@ -107,7 +79,7 @@ quiet_cmd_sphinx = SPHINX $@ --> file://$(abspath $(DOCS_DIST)/$5)
10779 -b $2 -c $3 -d $(DOCS_BUILD)/.doctrees $4 $(DOCS_DIST)/$5
10880
10981quiet_cmd_sphinx_autobuild = SPHINX $@ --> file://$(abspath $(DOCS_DIST)/$5)
110− cmd_sphinx_autobuild = PATH="$(PY_ENV_BIN):$(PATH)" $(PY_ENV_BIN)/sphinx-autobuild $(SPHINX_VERBOSE) --poll -B --host 0.0.0.0 --port 8080 $(SPHINXOPTS)\
82+ cmd_sphinx_autobuild = PATH="$(PY_ENV_BIN):$(PATH)" $(PY_ENV_BIN)/sphinx-autobuild $(SPHINX_VERBOSE) --open-browser --host 0.0.0.0 --port 8080 $(SPHINXOPTS)\
11183 -b $2 -c $3 -d $(DOCS_BUILD)/.doctrees $4 $(DOCS_DIST)/$5
11284
11385quiet_cmd_sphinx_clean = CLEAN $@