blob: 9d8bf531ae84fd3afc1df75326dc7ed45f77989d [file] [log] [blame]
Aric Gardnerf1f16c02020-02-05 14:58:31 -05001[tox]
2minversion = 1.6
3envlist = docs,
4# docs-linkcheck,
5
6skipsdist = true
7
8[testenv:docs]
9basepython = python3
10deps = -r{toxinidir}/../etc/requirements.txt
11commands =
12 sphinx-build -b html -n -d {envtmpdir}/doctrees ./ {toxinidir}/_build/html
13 echo "Generated docs available in {toxinidir}/docs/_build/html"
14whitelist_externals =
15 echo
16 git
17 sh
18
19[testenv:local]
20basepython = python3
21deps = -r{toxinidir}/../etc/requirements.txt
22commands =
23 git submodule update --depth 100 --init
24 sphinx-build -b html -n -d {envtmpdir}/doctrees ./ {toxinidir}/_build/html
25 echo "Generated docs available in {toxinidir}/_build/html"
26whitelist_externals =
27 echo
28 git
29
30[testenv:docs-linkcheck]
31basepython = python3
32deps = -r{toxinidir}/../etc/requirements.txt
33commands = echo "Link Checking not enforced"
34#commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck
35whitelist_externals =
36 echo
37
38[testenv:spellcheck]
39basepython = python3
40deps =
41 -r{toxinidir}/../etc/requirements.txt
42 sphinxcontrib-spelling
43commands =
44 sphinx-build -b spelling -Dextensions=sphinxcontrib.spelling -Dspelling_word_list_filename=validwords.txt -d {envtmpdir}/doctrees ./ {toxinidir}/_build/spellcheck