diff options
| author |   seanbeirne <sean.beirne@est.tech> | 2022-10-25 17:23:16 +0100 |
|---|---|---|
| committer | seanbeirne <sean.beirne@est.tech> | 2022-10-26 13:11:04 +0100 |
| commit | 6f7ec4b5ca172c6c301948d498093f1553920e27 (patch) | |
| tree | 0f4e079271d3e6e13dcdaf4d63eb8b31b5d37d6f /docs/tox.ini | |
| parent | ce0a150e63f4bdbd4c4538a3ae0040232698f7a5 (diff) | |
Finalise documentation as per doc procedure p02
Issue-ID: CPS-1321
Signed-off-by: seanbeirne <sean.beirne@est.tech>
Change-Id: If502aa0a8adca8cae6b856fb2d8f37e2eb16b590
Diffstat (limited to 'docs/tox.ini')
| -rw-r--r-- | docs/tox.ini | 38 |
1 files changed, 20 insertions, 18 deletions
diff --git a/docs/tox.ini b/docs/tox.ini index 9313c9e..dc46706 100644 --- a/docs/tox.ini +++ b/docs/tox.ini @@ -18,27 +18,29 @@ [tox] minversion = 1.6 -envlist = docs +envlist = docs,docs-linkcheck,docs-spellcheck skipsdist = true - [testenv:docs] 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 +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 -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 - -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt - -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt -commands = echo "Link Checking not enforced" -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 -Dextensions=sphinxcontrib.spelling -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/spellcheck |