blob: 71c69571ac24a695795087427982d6c9a9942230 [file] [log] [blame]
Jessica Wagantall6b71b532020-02-06 14:54:03 -08001[tox]
2minversion = 1.6
3envlist = docs,
4skipsdist = true
5
6[testenv:docs]
Cédric Ollivier171ce632022-08-31 22:24:36 +02007basepython = python3.8
thmsdt2d697472021-11-30 11:41:31 +01008deps =
9 -r{toxinidir}/requirements-docs.txt
Cédric Ollivier171ce632022-08-31 22:24:36 +020010 -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt
thmsdt2d697472021-11-30 11:41:31 +010011 -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt
Jessica Wagantall6b71b532020-02-06 14:54:03 -080012commands =
13 sphinx-build -b html -n -d {envtmpdir}/doctrees ./ {toxinidir}/_build/html
14 echo "Generated docs available in {toxinidir}/_build/html"
15whitelist_externals =
16 echo
17 git
18 sh
19
20[testenv:docs-linkcheck]
Cédric Ollivier171ce632022-08-31 22:24:36 +020021basepython = python3.8
thmsdt2d697472021-11-30 11:41:31 +010022deps =
23 -r{toxinidir}/requirements-docs.txt
Cédric Ollivier171ce632022-08-31 22:24:36 +020024 -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt
thmsdt2d697472021-11-30 11:41:31 +010025 -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt
Jessica Wagantall6b71b532020-02-06 14:54:03 -080026commands = echo "Link Checking not enforced"
27#commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./ {toxinidir}/_build/linkcheck
Cédric Ollivier171ce632022-08-31 22:24:36 +020028whitelist_externals = echo
marineMD22f97cb2022-11-16 16:38:32 +010029
30[testenv:docs-spellcheck]
31basepython = python3.8
32deps =
33 -r{toxinidir}/requirements-docs.txt
34 -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt
35 -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=master
36commands =
37 sphinx-build -W -q -b spelling -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/spellcheck
38
39
40