blob: 8921c368e657ede70a924cb3564d6f3f9470da9d [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 Bennett7d53abc2018-11-04 22:15:59 -05009 sphinx-build -j 1 -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"
Rich Bennett169c1342018-11-02 06:47:43 -040011whitelist_externals =
12 echo
13 git
14 sh
Rich Bennett22ef0852017-07-19 18:05:55 -040015
Cédric Ollivier268209c2017-11-10 11:31:53 +010016[testenv:local]
17deps = -r{toxinidir}/etc/requirements.txt
18commands =
19 git submodule update --depth 1 --init
20 sphinx-build -j 4 -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
21 echo "Generated docs available in {toxinidir}/docs/_build/html"
22whitelist_externals =
23 echo
24 git
25
Rich Bennett9c3af502018-04-26 09:30:57 -040026[testenv:linkcheck]
Rich Bennett22ef0852017-07-19 18:05:55 -040027deps = -r{toxinidir}/etc/requirements.txt
Rich Bennett79a88c72017-09-29 17:15:30 -040028commands = sphinx-build -j 4 -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck
Rich Bennett9c3af502018-04-26 09:30:57 -040029
30[testenv:spellcheck]
31deps =
32 -r{toxinidir}/etc/requirements.txt
33 sphinxcontrib-spelling
34commands =
35 sphinx-build -b spelling -Dextensions=sphinxcontrib.spelling -Dspelling_word_list_filename=validwords.txt -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/spellcheck