aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorCédric Ollivier <cedric.ollivier@orange.com>2022-04-11 16:28:46 +0200
committerCédric Ollivier <cedric.ollivier@orange.com>2022-04-11 16:28:46 +0200
commit2264544baa8d38930d60524c806cd32c1e7ac045 (patch)
tree1c06c24bb70edc28614ae5e86c75a02419883533
parent795c2d4349e04c4f7c0d4d5fb467727b8118b44a (diff)
Add bounds to sphinx requirement
As ONAP was created before Oct 20 2020 in RTD, we must set bounds to enforce a compatible Sphinx version (see manual). It also applied fixes which were applied during the previous release in all repos. Issue-ID: DOC-782 Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com> Change-Id: I684efed16ac46552bfaa989ded2a4515ee6cc6a0
-rw-r--r--docs/requirements-docs.txt17
-rw-r--r--docs/tox.ini10
2 files changed, 10 insertions, 17 deletions
diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt
index 0680dad1d..3b3441a80 100644
--- a/docs/requirements-docs.txt
+++ b/docs/requirements-docs.txt
@@ -1,16 +1,3 @@
-tox
-Sphinx>=2,<4
-doc8
-docutils
-setuptools
-six
-sphinx_rtd_theme>=0.4.3
-sphinxcontrib-blockdiag
-sphinxcontrib-needs>=0.2.3
-sphinxcontrib-nwdiag
-sphinxcontrib-seqdiag
-sphinxcontrib-swaggerdoc
-sphinxcontrib-plantuml
-sphinx_bootstrap_theme
lfdocs-conf
-sphinx-tabs \ No newline at end of file
+sphinx>=4.2.0 # BSD
+sphinx-rtd-theme>=1.0.0 # MIT
diff --git a/docs/tox.ini b/docs/tox.ini
index edac8c35f..884c455c1 100644
--- a/docs/tox.ini
+++ b/docs/tox.ini
@@ -5,7 +5,10 @@ skipsdist = true
[testenv:docs]
basepython = python3
-deps = -r{toxinidir}/requirements-docs.txt
+deps =
+ -r{toxinidir}/requirements-docs.txt
+ -chttps://git.onap.org/doc/plain/etc/upper-constraints.os.txt
+ -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt
commands =
sphinx-build -b html -n -d {envtmpdir}/doctrees ./ {toxinidir}/_build/html
echo "Generated docs available in {toxinidir}/_build/html"
@@ -16,7 +19,10 @@ whitelist_externals =
[testenv:docs-linkcheck]
basepython = python3
-#deps = -r{toxinidir}/requirements-docs.txt
+deps =
+ -r{toxinidir}/requirements-docs.txt
+ -chttps://git.onap.org/doc/plain/etc/upper-constraints.os.txt
+ -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt
commands = echo "Link Checking not enforced"
#commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./ {toxinidir}/_build/linkcheck
whitelist_externals = echo