summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEric Debeau <eric.debeau@orange.com>2021-09-30 16:29:28 +0200
committerEric Debeau <eric.debeau@orange.com>2021-09-30 16:30:47 +0200
commitb8f386bc7ab8d69d40de0ba677b62c917d04bd89 (patch)
treec333efa9e82427a8f45103258e03f23a305997c3
parent92373ddd2e28cc2000a2634d273836fea5d87a6e (diff)
[DOC] Correct requirements for doc chain building
- Remove unecessary requirements - It leverages the latest lfdocs-conf (0.7.7) updates - It now loads all centralized upper contraints from ONAP doc - Correct conf.py to use app.add_css_file() Issue-ID: DOC-765 Signed-off-by: Eric Debeau <eric.debeau@orange.com> Change-Id: Iff57eb863f783395144fcbd66a1c8347a65f9313
-rw-r--r--docs/conf.py2
-rw-r--r--docs/requirements-docs.txt16
-rw-r--r--docs/tox.ini12
3 files changed, 11 insertions, 19 deletions
diff --git a/docs/conf.py b/docs/conf.py
index 30ca786..9b84263 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -33,4 +33,4 @@ intersphinx_mapping = {}
html_last_updated_fmt = '%d-%b-%y %H:%M'
def setup(app):
- app.add_stylesheet("css/ribbon.css")
+ app.add_css_file("css/ribbon.css")
diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt
index 1cb2382..96c8de2 100644
--- a/docs/requirements-docs.txt
+++ b/docs/requirements-docs.txt
@@ -1,16 +1,2 @@
-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
-sphinxcontrib-redoc
lfdocs-conf
+sphinxcontrib-redoc
diff --git a/docs/tox.ini b/docs/tox.ini
index edac8c3..811bb5e 100644
--- a/docs/tox.ini
+++ b/docs/tox.ini
@@ -1,11 +1,14 @@
[tox]
minversion = 1.6
-envlist = docs,
+envlist = docs
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