summaryrefslogtreecommitdiffstats
path: root/docs/tox.ini
blob: 01fe1a3d5135b1f7306cfd20c423b48177e5c146 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
[tox]
minversion = 1.6
envlist = docs,docs-linkcheck,docs-spellcheck
skipsdist = true

[testenv:docs]
allowlist_externals =
    echo
    git
    sh
basepython = python3.8
deps =
    -r{toxinidir}/requirements-docs.txt
    -chttps://releases.openstack.org/constraints/upper/yoga
    -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=master
commands =
    sphinx-build -W -q -b html -n -d {envtmpdir}/doctrees ./ {toxinidir}/_build/html
    echo "Generated docs available in {toxinidir}/_build/html"


[testenv:docs-linkcheck]
basepython = python3.8
deps =
    -r{toxinidir}/requirements-docs.txt
    -chttps://releases.openstack.org/constraints/upper/yoga
    -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://releases.openstack.org/constraints/upper/yoga
    -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=master
commands = sphinx-build -W -q -b spelling -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/spellcheck