summaryrefslogtreecommitdiffstats
path: root/docs/tox.ini
blob: fa7db7633fa5a9e23f4ec6f042bb6f2f771829ff (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
36
37
38
39
[tox]
minversion = 1.6
envlist =
    docs,
    docs-linkcheck,
skipsdist = true

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

[testenv:docs-linkcheck]
basepython = python3.8
deps = -r{toxinidir}/requirements-docs.txt
#commands = echo "Link Checking not enforced"
commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./ {toxinidir}/_build/linkcheck
allowlist_externals = echo

[testenv:docs-spellcheck]
basepython = python3.8
deps =
    -r{toxinidir}/requirements-docs.txt
    -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt
    -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=montreal
commands =
    sphinx-build -W -q -b spelling -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/spellcheck