diff options
| author |   Eric Debeau <eric.debeau@orange.com> | 2021-09-30 16:16:22 +0200 |
|---|---|---|
| committer |   Seshu Kumar M <seshu.kumar.m@huawei.com> | 2021-09-30 14:47:24 +0000 |
| commit | 9c3974b55bc83b8a911706f5d4fc10cc5b7a6501 (patch) | |
| tree | bd598464cb0c9ab2725333075c5ace26e8899445 | |
| parent | c8746e6a8074c49c34a243f1aad0fa24201831dd (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: Ie8aa095bc9ac263a754734ea7d9bfff427ddcca0
| -rw-r--r-- | docs/conf.py | 2 | ||||
| -rw-r--r-- | docs/requirements-docs.txt | 14 | ||||
| -rw-r--r-- | docs/tox.ini | 12 |
3 files changed, 10 insertions, 18 deletions
diff --git a/docs/conf.py b/docs/conf.py index 5371015c66..d211470a62 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 b3188ddd38..74a3b7a3fd 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 edac8c35fc..811bb5e8ad 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 |