diff options
| author |   Eric Debeau <eric.debeau@orange.com> | 2021-10-01 14:54:48 +0200 |
|---|---|---|
| committer | Eric Debeau <eric.debeau@orange.com> | 2021-10-01 14:55:19 +0200 |
| commit | fe84d8f5a984880535eda8a1bba95bba096d09d1 (patch) | |
| tree | 20c6151df75477ca291733745600def9a9e888ea | |
| parent | 2f9c294f3dbe0b52b52df171f27d70e6833acb96 (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: Id4f0cd8b5718d3bbd09162bbe9c655053c72035c
| -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 96a8525..5082a4b 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")
\ No newline at end of file + app.add_css_file("css/ribbon.css")
\ No newline at end of file diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt index b3188dd..74a3b7a 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 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 |