diff options
| author |   liamfallon <liam.fallon@est.tech> | 2022-11-01 13:16:21 +0000 |
|---|---|---|
| committer | Liam Fallon <liam.fallon@est.tech> | 2022-11-01 17:00:48 +0000 |
| commit | 688a2dd3a681c28ac48ad737316c2dc1dff08526 (patch) | |
| tree | 2cec8ad6af476f64fdf13f495788a277ee88644b /docs/tox.ini | |
| parent | b0f136169fcf812b4f030a6d0ffe2817977b313c (diff) | |
Fix doc config files and dead links
Documentation config fixed as instructed.
Configuration files have been copied from examples provided by the
documentation project.
Dead links are fixed as well, they cause build fails now.
Issue-ID: POLICY-4426
Change-Id: Ied5ca5e5a24f7a625e5b2d94c46d0c2347c68ace
Signed-off-by: liamfallon <liam.fallon@est.tech>
Diffstat (limited to 'docs/tox.ini')
| -rw-r--r-- | docs/tox.ini | 30 |
1 files changed, 18 insertions, 12 deletions
diff --git a/docs/tox.ini b/docs/tox.ini index 49bbe010..b9d7eb44 100644 --- a/docs/tox.ini +++ b/docs/tox.ini @@ -1,6 +1,6 @@ [tox] minversion = 1.6 -envlist = docs, +envlist = docs,docs-linkcheck,docs-spellcheck skipsdist = true [testenv:docs] @@ -8,18 +8,24 @@ basepython = python3.8 deps = -r{toxinidir}/requirements-docs.txt -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt - -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt + -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=master commands = - sphinx-build -b html -n -d {envtmpdir}/doctrees ./ {toxinidir}/_build/html - echo "Generated docs available in {toxinidir}/_build/html" -whitelist_externals = - echo - git - sh + sphinx-build -W -q -b html -n -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/html [testenv:docs-linkcheck] basepython = python3.8 -#deps = -r{toxinidir}/requirements-docs.txt -commands = echo "Link Checking not enforced" -#commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./ {toxinidir}/_build/linkcheck -whitelist_externals = echo +deps = + -r{toxinidir}/requirements-docs.txt + -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt + -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=master +commands = + sphinx-build -W -q -b linkcheck -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/linkcheck + +[testenv:docs-spellcheck] +basepython = python3.8 +deps = + -r{toxinidir}/requirements-docs.txt + -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt + -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=master +commands = + sphinx-build -W -q -b spelling -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/spellcheck |