diff options
| author |   Ramesh Murugan Iyer <ramesh.murugan.iyer@est.tech> | 2022-11-02 07:26:55 +0000 |
|---|---|---|
| committer |   Gerrit Code Review <gerrit@onap.org> | 2022-11-02 07:26:55 +0000 |
| commit | 782ccb88294a3b43fdd368ae3a98fdd72aca0c24 (patch) | |
| tree | 791531c264a04554fd3f66a77016286e4f6ac1ca /docs/tox.ini | |
| parent | 0645b537ab50bbda1757c49a626d987ff9b34467 (diff) | |
| parent | 688a2dd3a681c28ac48ad737316c2dc1dff08526 (diff) | |
Merge "Fix doc config files and dead links"
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 |