aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorCédric Ollivier <cedric.ollivier@orange.com>2021-10-21 15:10:26 +0200
committerCédric Ollivier <cedric.ollivier@orange.com>2021-10-21 15:14:33 +0200
commit170436a76040880e8186b9b9740cb4ca9ac3a680 (patch)
tree3300042752a17a8c744fd9a0ae72b988700b331c
parent73ae0fc139d92421a038d737bf9058a96dfd7220 (diff)
Leverage upper-constraints files to pin all dependencies
It leverages the latest change from lfdocs-conf and the upper-constraints.txt now centralized in ONAP docs. In a long run, upperconstraints.os.txt should be removed once ONAP is synced with OpenStack. It removes tox and setuptools from requirements as nothing depends on them (most requirements should be removed except lfdocsconf) Issue-ID: DOC-765 Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com> Change-Id: Id90ff3878230ace3b46f8964621b3fefcd23a556 (cherry picked from commit b02ac53a7b6a4b750c542f8d07639751a2eb61ba)
-rw-r--r--docs/conf.py2
-rw-r--r--docs/requirements-docs.txt14
-rw-r--r--docs/tox.ini5
-rw-r--r--tox.ini5
4 files changed, 9 insertions, 17 deletions
diff --git a/docs/conf.py b/docs/conf.py
index 8f40e8b8..3b28eb74 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -12,4 +12,4 @@ intersphinx_mapping = {}
html_last_updated_fmt = '%d-%b-%y %H:%M'
def setup(app):
- app.add_stylesheet("css/ribbon_onap.css")
+ app.add_css_file("css/ribbon_onap.css")
diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt
index b3188ddd..74a3b7a3 100644
--- a/docs/requirements-docs.txt
+++ b/docs/requirements-docs.txt
@@ -1,15 +1 @@
-tox
-Sphinx
-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
diff --git a/docs/tox.ini b/docs/tox.ini
index edac8c35..bf9bc51f 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?h=istanbul
+ -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=istanbul
commands =
sphinx-build -b html -n -d {envtmpdir}/doctrees ./ {toxinidir}/_build/html
echo "Generated docs available in {toxinidir}/_build/html"
diff --git a/tox.ini b/tox.ini
index 7c66248c..7ac8aa74 100644
--- a/tox.ini
+++ b/tox.ini
@@ -34,5 +34,8 @@ commands = bash -c "find {toxinidir} -not -path {toxinidir}/.tox/\* \
-name \*.rst -type f -print0 | xargs -0 rstcheck --report warning"
[testenv:docs]
-deps = sphinx
+deps =
+ -r{toxinidir}/docs/requirements-docs.txt
+ -chttps://git.onap.org/doc/plain/etc/upper-constraints.os.txt?h=istanbul
+ -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=istanbul
commands = sphinx-build -W -b html docs docs/build/html