blob: 3efa9479851b9381b8c088d463aab29ceaa4d348 [file] [log] [blame]
Jessica Wagantall449c8be2020-02-06 13:25:49 -08001[tox]
2minversion = 1.6
PatrikBuhr9f1d9492023-04-17 13:00:15 +02003envlist =
4 docs,
5 docs-linkcheck,
Jessica Wagantall449c8be2020-02-06 13:25:49 -08006skipsdist = true
7
8[testenv:docs]
Cédric Ollivieraa00b4c2022-08-31 21:13:53 +02009basepython = python3.8
Cédric Ollivierccd50402021-10-22 10:29:25 +020010deps =
11 -r{toxinidir}/requirements-docs.txt
thmsdt1e37e192024-02-27 11:28:17 +010012 -chttps://releases.openstack.org/constraints/upper/yoga
Cédric Ollivierccd50402021-10-22 10:29:25 +020013 -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt
Jessica Wagantall449c8be2020-02-06 13:25:49 -080014commands =
Dan Timoneya9cc0c32023-03-30 20:32:17 -040015 sphinx-build -W -b html -n -d {envtmpdir}/doctrees ./ {toxinidir}/_build/html
Jessica Wagantall449c8be2020-02-06 13:25:49 -080016 echo "Generated docs available in {toxinidir}/_build/html"
PatrikBuhr9f1d9492023-04-17 13:00:15 +020017allowlist_externals =
Jessica Wagantall449c8be2020-02-06 13:25:49 -080018 echo
19 git
20 sh
21
22[testenv:docs-linkcheck]
Cédric Ollivieraa00b4c2022-08-31 21:13:53 +020023basepython = python3.8
PatrikBuhr9f1d9492023-04-17 13:00:15 +020024deps = -r{toxinidir}/requirements-docs.txt
25#commands = echo "Link Checking not enforced"
26commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./ {toxinidir}/_build/linkcheck
27allowlist_externals = echo
marineMDed0b1822022-11-14 15:46:34 +010028
29[testenv:docs-spellcheck]
30basepython = python3.8
31deps =
32 -r{toxinidir}/requirements-docs.txt
thmsdt1e37e192024-02-27 11:28:17 +010033 -chttps://releases.openstack.org/constraints/upper/yoga
marineMDed0b1822022-11-14 15:46:34 +010034 -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=master
35commands =
36 sphinx-build -W -q -b spelling -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/spellcheck
37
38
39