| 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] |
| mrichomme | eb7de50 | 2019-11-29 11:11:27 +0100 | [diff] [blame] | 7 | basepython = python3 |
| Aric Gardner | 0fb94b1 | 2020-01-28 15:21:34 -0500 | [diff] [blame] | 8 | deps = -r{toxinidir}/docs/requirements-docs.txt |
| Rich Bennett | 22ef085 | 2017-07-19 18:05:55 -0400 | [diff] [blame] | 9 | commands = |
| mrichomme | 4de8b08 | 2019-11-29 15:14:23 +0100 | [diff] [blame] | 10 | 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] | 11 | echo "Generated docs available in {toxinidir}/docs/_build/html" |
| Rich Bennett | 169c134 | 2018-11-02 06:47:43 -0400 | [diff] [blame] | 12 | whitelist_externals = |
| 13 | echo |
| 14 | git |
| 15 | sh |
| Rich Bennett | 22ef085 | 2017-07-19 18:05:55 -0400 | [diff] [blame] | 16 | |
| Cédric Ollivier | 268209c | 2017-11-10 11:31:53 +0100 | [diff] [blame] | 17 | [testenv:local] |
| mrichomme | eb7de50 | 2019-11-29 11:11:27 +0100 | [diff] [blame] | 18 | basepython = python3 |
| Aric Gardner | 0fb94b1 | 2020-01-28 15:21:34 -0500 | [diff] [blame] | 19 | deps = -r{toxinidir}/docs/requirements-docs.txt |
| Cédric Ollivier | 268209c | 2017-11-10 11:31:53 +0100 | [diff] [blame] | 20 | commands = |
| Hagop Bozawglanian | 4cc3e88 | 2019-09-04 21:17:28 +0000 | [diff] [blame] | 21 | git submodule update --depth 100 --init |
| mrichomme | 4de8b08 | 2019-11-29 15:14:23 +0100 | [diff] [blame] | 22 | 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] | 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] |
| mrichomme | eb7de50 | 2019-11-29 11:11:27 +0100 | [diff] [blame] | 29 | basepython = python3 |
| Rich Bennett | 22ef085 | 2017-07-19 18:05:55 -0400 | [diff] [blame] | 30 | deps = -r{toxinidir}/etc/requirements.txt |
| mrichomme | 4de8b08 | 2019-11-29 15:14:23 +0100 | [diff] [blame] | 31 | commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck |
| Rich Bennett | 9c3af50 | 2018-04-26 09:30:57 -0400 | [diff] [blame] | 32 | |
| 33 | [testenv:spellcheck] |
| mrichomme | eb7de50 | 2019-11-29 11:11:27 +0100 | [diff] [blame] | 34 | basepython = python3 |
| Rich Bennett | 9c3af50 | 2018-04-26 09:30:57 -0400 | [diff] [blame] | 35 | deps = |
| 36 | -r{toxinidir}/etc/requirements.txt |
| 37 | sphinxcontrib-spelling |
| 38 | commands = |
| 39 | sphinx-build -b spelling -Dextensions=sphinxcontrib.spelling -Dspelling_word_list_filename=validwords.txt -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/spellcheck |