blob: 0b0d4e61af5055eaba52daf43963a7b14d00e6da [file] [log] [blame]
Jessica Wagantall449c8be2020-02-06 13:25:49 -08001[tox]
2minversion = 1.6
3envlist = docs,
4skipsdist = true
5
6[testenv:docs]
Cédric Ollivieraa00b4c2022-08-31 21:13:53 +02007basepython = python3.8
Cédric Ollivierccd50402021-10-22 10:29:25 +02008deps =
9 -r{toxinidir}/requirements-docs.txt
Cédric Ollivieraa00b4c2022-08-31 21:13:53 +020010 -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt
Cédric Ollivierccd50402021-10-22 10:29:25 +020011 -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt
Jessica Wagantall449c8be2020-02-06 13:25:49 -080012commands =
Dan Timoneya9cc0c32023-03-30 20:32:17 -040013 sphinx-build -W -b html -n -d {envtmpdir}/doctrees ./ {toxinidir}/_build/html
Jessica Wagantall449c8be2020-02-06 13:25:49 -080014 echo "Generated docs available in {toxinidir}/_build/html"
15whitelist_externals =
16 echo
17 git
18 sh
19
20[testenv:docs-linkcheck]
Cédric Ollivieraa00b4c2022-08-31 21:13:53 +020021basepython = python3.8
Jessica Wagantall449c8be2020-02-06 13:25:49 -080022#deps = -r{toxinidir}/requirements-docs.txt
23commands = echo "Link Checking not enforced"
24#commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./ {toxinidir}/_build/linkcheck
25whitelist_externals = echo
marineMDed0b1822022-11-14 15:46:34 +010026
27[testenv:docs-spellcheck]
28basepython = python3.8
29deps =
30 -r{toxinidir}/requirements-docs.txt
31 -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt
32 -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=master
33commands =
34 sphinx-build -W -q -b spelling -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/spellcheck
35
36
37