| Rich Bennett | 22ef085 | 2017-07-19 18:05:55 -0400 | [diff] [blame] | 1 | [tox] |
| 2 | minversion = 1.6 |
| Guillaume Lambert | 723363b | 2021-02-02 14:15:40 +0100 | [diff] [blame] | 3 | envlist = docs,docs-linkcheck |
| 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 | dd7413d | 2020-02-05 13:15:34 -0500 | [diff] [blame] | 8 | deps = -r{toxinidir}/etc/requirements.txt |
| Rich Bennett | 22ef085 | 2017-07-19 18:05:55 -0400 | [diff] [blame] | 9 | commands = |
| Guillaume Lambert | dbf9177 | 2021-04-23 11:14:34 +0200 | [diff] [blame] | 10 | sphinx-build -W -q -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 | |
| Andrea Visnyei | 32d2daf | 2020-12-09 12:26:35 +0100 | [diff] [blame] | 17 | [testenv:docs-templates] |
| 18 | basepython = python3 |
| 19 | deps = -r{toxinidir}/etc/requirements.txt |
| 20 | commands = |
| 21 | sphinx-build -b html -n -d {envtmpdir}/doctrees -c {toxinidir}/docs ./docs/guides/onap-developer/how-to-use-docs/templates {toxinidir}/docs/_build/html/templates |
| 22 | echo "Generated docs available in {toxinidir}/docs/_build/html/templates" |
| 23 | whitelist_externals = |
| 24 | echo |
| 25 | |
| Cédric Ollivier | 268209c | 2017-11-10 11:31:53 +0100 | [diff] [blame] | 26 | [testenv:local] |
| mrichomme | eb7de50 | 2019-11-29 11:11:27 +0100 | [diff] [blame] | 27 | basepython = python3 |
| Aric Gardner | dd7413d | 2020-02-05 13:15:34 -0500 | [diff] [blame] | 28 | deps = -r{toxinidir}/etc/requirements.txt |
| Cédric Ollivier | 268209c | 2017-11-10 11:31:53 +0100 | [diff] [blame] | 29 | commands = |
| Hagop Bozawglanian | 4cc3e88 | 2019-09-04 21:17:28 +0000 | [diff] [blame] | 30 | git submodule update --depth 100 --init |
| Guillaume Lambert | dbf9177 | 2021-04-23 11:14:34 +0200 | [diff] [blame] | 31 | sphinx-build -q -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html |
| Cédric Ollivier | 268209c | 2017-11-10 11:31:53 +0100 | [diff] [blame] | 32 | echo "Generated docs available in {toxinidir}/docs/_build/html" |
| 33 | whitelist_externals = |
| 34 | echo |
| 35 | git |
| 36 | |
| Aric Gardner | dd7413d | 2020-02-05 13:15:34 -0500 | [diff] [blame] | 37 | [testenv:docs-linkcheck] |
| mrichomme | eb7de50 | 2019-11-29 11:11:27 +0100 | [diff] [blame] | 38 | basepython = python3 |
| Rich Bennett | 22ef085 | 2017-07-19 18:05:55 -0400 | [diff] [blame] | 39 | deps = -r{toxinidir}/etc/requirements.txt |
| Guillaume Lambert | dbf9177 | 2021-04-23 11:14:34 +0200 | [diff] [blame] | 40 | commands = sphinx-build -q -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck |
| Rich Bennett | 9c3af50 | 2018-04-26 09:30:57 -0400 | [diff] [blame] | 41 | |
| 42 | [testenv:spellcheck] |
| mrichomme | eb7de50 | 2019-11-29 11:11:27 +0100 | [diff] [blame] | 43 | basepython = python3 |
| Rich Bennett | 9c3af50 | 2018-04-26 09:30:57 -0400 | [diff] [blame] | 44 | deps = |
| 45 | -r{toxinidir}/etc/requirements.txt |
| 46 | sphinxcontrib-spelling |
| Guillaume Lambert | 723363b | 2021-02-02 14:15:40 +0100 | [diff] [blame] | 47 | commands = |
| Guillaume Lambert | 1abd85a | 2021-02-10 11:21:02 +0100 | [diff] [blame] | 48 | sphinx-build -b spelling -Dextensions=sphinxcontrib.spelling -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/spellcheck |
| Guillaume Lambert | 9015be3 | 2021-02-17 11:46:10 +0100 | [diff] [blame] | 49 | |
| 50 | [testenv:autopep8] |
| 51 | deps = autopep8 |
| 52 | commands = |
| 53 | autopep8 --max-line-length 120 --in-place docs/conf.py |
| 54 | |
| 55 | [testenv:pylint] |
| 56 | deps = pylint |
| 57 | commands = |
| 58 | pylint --max-line-length=120 --disable=missing-docstring --reports=y --score=y --output-format=colorized docs/conf.py |