blob: d94b1129b9c8aa60ab818fc1227921178f719c2f [file] [log] [blame]
Rich Bennett22ef0852017-07-19 18:05:55 -04001[tox]
2minversion = 1.6
Rich Bennett3beeced2017-09-18 10:01:25 -04003envlist = docs
Rich Bennett22ef0852017-07-19 18:05:55 -04004skipsdist = true
5
6[testenv:docs]
7deps = -r{toxinidir}/etc/requirements.txt
8commands =
Rich Bennett79a88c72017-09-29 17:15:30 -04009 sphinx-build -j 4 -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
Rich Bennett22ef0852017-07-19 18:05:55 -040010 echo "Generated docs available in {toxinidir}/docs/_build/html"
11whitelist_externals = echo
12
Cédric Ollivier268209c2017-11-10 11:31:53 +010013[testenv:local]
14deps = -r{toxinidir}/etc/requirements.txt
15commands =
16 git submodule update --depth 1 --init
17 sphinx-build -j 4 -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
18 echo "Generated docs available in {toxinidir}/docs/_build/html"
19whitelist_externals =
20 echo
21 git
22
Rich Bennett9c3af502018-04-26 09:30:57 -040023[testenv:linkcheck]
Rich Bennett22ef0852017-07-19 18:05:55 -040024deps = -r{toxinidir}/etc/requirements.txt
Rich Bennett79a88c72017-09-29 17:15:30 -040025commands = sphinx-build -j 4 -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck
Rich Bennett9c3af502018-04-26 09:30:57 -040026
27[testenv:spellcheck]
28deps =
29 -r{toxinidir}/etc/requirements.txt
30 sphinxcontrib-spelling
31commands =
32 sphinx-build -b spelling -Dextensions=sphinxcontrib.spelling -Dspelling_word_list_filename=validwords.txt -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/spellcheck