summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEric Debeau <eric.debeau@orange.com>2021-09-29 21:28:28 +0200
committerVijay Venkatesh Kumar <vv770d@att.com>2021-09-29 21:13:09 +0000
commit9c2274e6f0053410c4937db25b93eb28054a23b9 (patch)
tree117ef4a663080918a60d3fd29f95ece52d3d45bf
parent31f307cdddc6c887996b357c59588bc18653df28 (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: I56d0372e56733850de9cc0d15a6355bc7af9e823 (cherry picked from commit ea5c42a971a88d4086e8e6b730a8c153a73180b3)
-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 5371015c..d211470a 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.css")
+ app.add_css_file("css/ribbon.css")
diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt
index b3188ddd..5a3d2f17 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
+lfdocs-conf \ No newline at end of file
diff --git a/docs/tox.ini b/docs/tox.ini
index edac8c35..037606f5 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
+whitelist_externals = echo \ No newline at end of file