Rich Bennett | 22ef085 | 2017-07-19 18:05:55 -0400 | [diff] [blame] | 1 | [tox] |
| 2 | minversion = 1.6 |
Rich Bennett | 3beeced | 2017-09-18 10:01:25 -0400 | [diff] [blame] | 3 | envlist = docs |
Rich Bennett | 22ef085 | 2017-07-19 18:05:55 -0400 | [diff] [blame] | 4 | skipsdist = true |
| 5 | |
| 6 | [testenv:docs] |
| 7 | deps = -r{toxinidir}/etc/requirements.txt |
| 8 | commands = |
Rich Bennett | 79a88c7 | 2017-09-29 17:15:30 -0400 | [diff] [blame] | 9 | sphinx-build -j 4 -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html |
Rich Bennett | 22ef085 | 2017-07-19 18:05:55 -0400 | [diff] [blame] | 10 | echo "Generated docs available in {toxinidir}/docs/_build/html" |
| 11 | whitelist_externals = echo |
| 12 | |
Cédric Ollivier | 268209c | 2017-11-10 11:31:53 +0100 | [diff] [blame] | 13 | [testenv:local] |
| 14 | deps = -r{toxinidir}/etc/requirements.txt |
| 15 | commands = |
| 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" |
| 19 | whitelist_externals = |
| 20 | echo |
| 21 | git |
| 22 | |
Rich Bennett | 9c3af50 | 2018-04-26 09:30:57 -0400 | [diff] [blame] | 23 | [testenv:linkcheck] |
Rich Bennett | 22ef085 | 2017-07-19 18:05:55 -0400 | [diff] [blame] | 24 | deps = -r{toxinidir}/etc/requirements.txt |
Rich Bennett | 79a88c7 | 2017-09-29 17:15:30 -0400 | [diff] [blame] | 25 | commands = sphinx-build -j 4 -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck |
Rich Bennett | 9c3af50 | 2018-04-26 09:30:57 -0400 | [diff] [blame] | 26 | |
| 27 | [testenv:spellcheck] |
| 28 | deps = |
| 29 | -r{toxinidir}/etc/requirements.txt |
| 30 | sphinxcontrib-spelling |
| 31 | commands = |
| 32 | sphinx-build -b spelling -Dextensions=sphinxcontrib.spelling -Dspelling_word_list_filename=validwords.txt -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/spellcheck |