| 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 | a61abf1 | 2018-11-12 09:07:41 -0500 | [diff] [blame^] | 9 | sh {toxinidir}/shell/smsummary.sh {toxinidir}/docs/_static/smsummary.out |
| 10 | echo "Summary of submodule versions used in html build in {toxinidir}/docs/_static/smsummary.out" |
| 11 | sphinx-build -j 1 -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html |
| Rich Bennett | 22ef085 | 2017-07-19 18:05:55 -0400 | [diff] [blame] | 12 | echo "Generated docs available in {toxinidir}/docs/_build/html" |
| Rich Bennett | a61abf1 | 2018-11-12 09:07:41 -0500 | [diff] [blame^] | 13 | whitelist_externals = |
| 14 | echo |
| 15 | git |
| 16 | sh |
| Rich Bennett | 22ef085 | 2017-07-19 18:05:55 -0400 | [diff] [blame] | 17 | |
| Cédric Ollivier | 268209c | 2017-11-10 11:31:53 +0100 | [diff] [blame] | 18 | [testenv:local] |
| 19 | deps = -r{toxinidir}/etc/requirements.txt |
| 20 | commands = |
| 21 | git submodule update --depth 1 --init |
| 22 | sphinx-build -j 4 -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html |
| 23 | echo "Generated docs available in {toxinidir}/docs/_build/html" |
| 24 | whitelist_externals = |
| 25 | echo |
| 26 | git |
| 27 | |
| Rich Bennett | 9c3af50 | 2018-04-26 09:30:57 -0400 | [diff] [blame] | 28 | [testenv:linkcheck] |
| Rich Bennett | 22ef085 | 2017-07-19 18:05:55 -0400 | [diff] [blame] | 29 | deps = -r{toxinidir}/etc/requirements.txt |
| Rich Bennett | 79a88c7 | 2017-09-29 17:15:30 -0400 | [diff] [blame] | 30 | 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] | 31 | |
| 32 | [testenv:spellcheck] |
| 33 | deps = |
| 34 | -r{toxinidir}/etc/requirements.txt |
| 35 | sphinxcontrib-spelling |
| 36 | commands = |
| 37 | sphinx-build -b spelling -Dextensions=sphinxcontrib.spelling -Dspelling_word_list_filename=validwords.txt -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/spellcheck |