blob: b0a7bbafa3659ba595a9680b0f42d4af44e25c1c [file] [log] [blame]
efiacor0fb3b8f2022-10-28 15:29:26 +01001[tox]
2minversion = 1.6
3envlist = docs,docs-linkcheck,docs-spellcheck
4skipsdist = true
5
6[testenv:docs]
7basepython = python3.8
8deps =
9 -r{toxinidir}/requirements-docs.txt
Andreas Geissleree7e3ad2024-02-28 14:30:53 +010010 -chttps://releases.openstack.org/constraints/upper/yoga
efiacor0fb3b8f2022-10-28 15:29:26 +010011 -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=master
Andreas Geissler691906d2023-09-25 10:57:56 +020012allowlist_externals = sudo
efiacor0fb3b8f2022-10-28 15:29:26 +010013commands =
Andreas Geissler691906d2023-09-25 10:57:56 +020014 sudo apt install graphviz
efiacor0fb3b8f2022-10-28 15:29:26 +010015 sphinx-build -W -q -b html -n -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/html
16
17[testenv:docs-linkcheck]
18basepython = python3.8
19deps =
20 -r{toxinidir}/requirements-docs.txt
Andreas Geissleree7e3ad2024-02-28 14:30:53 +010021 -chttps://releases.openstack.org/constraints/upper/yoga
efiacor0fb3b8f2022-10-28 15:29:26 +010022 -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=master
Andreas Geissler691906d2023-09-25 10:57:56 +020023allowlist_externals = sudo
efiacor0fb3b8f2022-10-28 15:29:26 +010024commands =
Andreas Geissler691906d2023-09-25 10:57:56 +020025 sudo apt install graphviz
efiacor0fb3b8f2022-10-28 15:29:26 +010026 sphinx-build -W -q -b linkcheck -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/linkcheck
27
28[testenv:docs-spellcheck]
29basepython = python3.8
30deps =
31 -r{toxinidir}/requirements-docs.txt
Andreas Geissleree7e3ad2024-02-28 14:30:53 +010032 -chttps://releases.openstack.org/constraints/upper/yoga
efiacor0fb3b8f2022-10-28 15:29:26 +010033 -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=master
Andreas Geissler691906d2023-09-25 10:57:56 +020034allowlist_externals = sudo
efiacor0fb3b8f2022-10-28 15:29:26 +010035commands =
Andreas Geissler691906d2023-09-25 10:57:56 +020036 sudo apt install graphviz
efiacor0fb3b8f2022-10-28 15:29:26 +010037 sphinx-build -b spelling -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/spellcheck
38