| Rich Bennett | 22ef085 | 2017-07-19 18:05:55 -0400 | [diff] [blame] | 1 | [tox] |
| 2 | minversion = 1.6 |
| Aric Gardner | dd7413d | 2020-02-05 13:15:34 -0500 | [diff] [blame] | 3 | envlist = docs, |
| 4 | # docs-linkcheck, |
| 5 | |
| Rich Bennett | 22ef085 | 2017-07-19 18:05:55 -0400 | [diff] [blame] | 6 | skipsdist = true |
| 7 | |
| 8 | [testenv:docs] |
| mrichomme | eb7de50 | 2019-11-29 11:11:27 +0100 | [diff] [blame] | 9 | basepython = python3 |
| Aric Gardner | dd7413d | 2020-02-05 13:15:34 -0500 | [diff] [blame] | 10 | deps = -r{toxinidir}/etc/requirements.txt |
| Rich Bennett | 22ef085 | 2017-07-19 18:05:55 -0400 | [diff] [blame] | 11 | commands = |
| mrichomme | 4de8b08 | 2019-11-29 15:14:23 +0100 | [diff] [blame] | 12 | sphinx-build -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html |
| Rich Bennett | 22ef085 | 2017-07-19 18:05:55 -0400 | [diff] [blame] | 13 | echo "Generated docs available in {toxinidir}/docs/_build/html" |
| Rich Bennett | 169c134 | 2018-11-02 06:47:43 -0400 | [diff] [blame] | 14 | whitelist_externals = |
| 15 | echo |
| 16 | git |
| 17 | sh |
| Rich Bennett | 22ef085 | 2017-07-19 18:05:55 -0400 | [diff] [blame] | 18 | |
| Cédric Ollivier | 268209c | 2017-11-10 11:31:53 +0100 | [diff] [blame] | 19 | [testenv:local] |
| mrichomme | eb7de50 | 2019-11-29 11:11:27 +0100 | [diff] [blame] | 20 | basepython = python3 |
| Aric Gardner | dd7413d | 2020-02-05 13:15:34 -0500 | [diff] [blame] | 21 | deps = -r{toxinidir}/etc/requirements.txt |
| Cédric Ollivier | 268209c | 2017-11-10 11:31:53 +0100 | [diff] [blame] | 22 | commands = |
| Hagop Bozawglanian | 4cc3e88 | 2019-09-04 21:17:28 +0000 | [diff] [blame] | 23 | git submodule update --depth 100 --init |
| mrichomme | 4de8b08 | 2019-11-29 15:14:23 +0100 | [diff] [blame] | 24 | sphinx-build -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html |
| Cédric Ollivier | 268209c | 2017-11-10 11:31:53 +0100 | [diff] [blame] | 25 | echo "Generated docs available in {toxinidir}/docs/_build/html" |
| 26 | whitelist_externals = |
| 27 | echo |
| 28 | git |
| 29 | |
| Aric Gardner | dd7413d | 2020-02-05 13:15:34 -0500 | [diff] [blame] | 30 | [testenv:docs-linkcheck] |
| mrichomme | eb7de50 | 2019-11-29 11:11:27 +0100 | [diff] [blame] | 31 | basepython = python3 |
| Rich Bennett | 22ef085 | 2017-07-19 18:05:55 -0400 | [diff] [blame] | 32 | deps = -r{toxinidir}/etc/requirements.txt |
| Aric Gardner | dd7413d | 2020-02-05 13:15:34 -0500 | [diff] [blame] | 33 | commands = echo "Link Checking not enforced" |
| 34 | #commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck |
| 35 | whitelist_externals = |
| 36 | echo |
| Rich Bennett | 9c3af50 | 2018-04-26 09:30:57 -0400 | [diff] [blame] | 37 | |
| 38 | [testenv:spellcheck] |
| mrichomme | eb7de50 | 2019-11-29 11:11:27 +0100 | [diff] [blame] | 39 | basepython = python3 |
| Rich Bennett | 9c3af50 | 2018-04-26 09:30:57 -0400 | [diff] [blame] | 40 | deps = |
| 41 | -r{toxinidir}/etc/requirements.txt |
| 42 | sphinxcontrib-spelling |
| 43 | commands = |
| 44 | sphinx-build -b spelling -Dextensions=sphinxcontrib.spelling -Dspelling_word_list_filename=validwords.txt -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/spellcheck |