| Cédric Ollivier | 3093269 | 2021-11-22 14:21:29 +0100 | [diff] [blame] | 1 | [tox] |
| 2 | minversion = 1.6 |
| 3 | envlist = docs,docs-linkcheck |
| 4 | skipsdist = true |
| 5 | |
| 6 | [testenv:docs] |
| 7 | basepython = python3 |
| 8 | deps = |
| thmsdt | acd34d7 | 2022-07-18 14:51:16 +0200 | [diff] [blame] | 9 | -r{toxinidir}/etc/requirements-docs.txt |
| 10 | -c{toxinidir}/etc/upper-constraints.os.txt |
| 11 | -c{toxinidir}/etc/upper-constraints.onap.txt |
| Cédric Ollivier | 3093269 | 2021-11-22 14:21:29 +0100 | [diff] [blame] | 12 | commands = |
| thmsdt | acd34d7 | 2022-07-18 14:51:16 +0200 | [diff] [blame] | 13 | sphinx-build -W -q -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html |
| 14 | echo "Generated docs available in {toxinidir}/docs/_build/html" |
| Cédric Ollivier | 3093269 | 2021-11-22 14:21:29 +0100 | [diff] [blame] | 15 | whitelist_externals = |
| 16 | echo |
| thmsdt | acd34d7 | 2022-07-18 14:51:16 +0200 | [diff] [blame] | 17 | git |
| 18 | sh |
| 19 | |
| 20 | [testenv:docs-templates] |
| 21 | basepython = python3 |
| 22 | deps = |
| 23 | -r{toxinidir}/etc/requirements-docs.txt |
| 24 | -c{toxinidir}/etc/upper-constraints.os.txt |
| 25 | -c{toxinidir}/etc/upper-constraints.onap.txt |
| 26 | commands = |
| 27 | 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 |
| 28 | echo "Generated docs available in {toxinidir}/docs/_build/html/templates" |
| 29 | whitelist_externals = |
| 30 | echo |
| 31 | |
| 32 | [testenv:local] |
| 33 | basepython = python3 |
| 34 | deps = |
| 35 | -r{toxinidir}/etc/requirements-docs.txt |
| 36 | -c{toxinidir}/etc/upper-constraints.os.txt |
| 37 | -c{toxinidir}/etc/upper-constraints.onap.txt |
| 38 | commands = |
| 39 | git submodule update --depth 100 --init |
| 40 | sphinx-build -q -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html |
| 41 | echo "Generated docs available in {toxinidir}/docs/_build/html" |
| 42 | whitelist_externals = |
| 43 | echo |
| 44 | git |
| Cédric Ollivier | 3093269 | 2021-11-22 14:21:29 +0100 | [diff] [blame] | 45 | |
| 46 | [testenv:docs-linkcheck] |
| 47 | basepython = python3 |
| 48 | deps = |
| thmsdt | acd34d7 | 2022-07-18 14:51:16 +0200 | [diff] [blame] | 49 | -r{toxinidir}/etc/requirements-docs.txt |
| 50 | -c{toxinidir}/etc/upper-constraints.os.txt |
| 51 | -c{toxinidir}/etc/upper-constraints.onap.txt |
| 52 | commands = sphinx-build -W -q -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck |
| 53 | |
| 54 | [testenv:spellcheck] |
| 55 | basepython = python3 |
| 56 | deps = |
| 57 | -r{toxinidir}/etc/requirements-docs.txt |
| 58 | -c{toxinidir}/etc/upper-constraints.os.txt |
| 59 | -c{toxinidir}/etc/upper-constraints.onap.txt |
| Cédric Ollivier | 3093269 | 2021-11-22 14:21:29 +0100 | [diff] [blame] | 60 | commands = |
| thmsdt | acd34d7 | 2022-07-18 14:51:16 +0200 | [diff] [blame] | 61 | sphinx-build -b spelling -Dextensions=sphinxcontrib.spelling -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/spellcheck |
| 62 | |
| 63 | [testenv:autopep8] |
| 64 | deps = |
| 65 | -r{toxinidir}/etc/requirements-docs.txt |
| 66 | -c{toxinidir}/etc/upper-constraints.os.txt |
| 67 | -c{toxinidir}/etc/upper-constraints.onap.txt |
| 68 | commands = |
| 69 | autopep8 --max-line-length 120 --in-place docs/conf.py |
| 70 | |
| 71 | [testenv:pylint] |
| 72 | deps = |
| 73 | -r{toxinidir}/etc/requirements-docs.txt |
| 74 | -c{toxinidir}/etc/upper-constraints.os.txt |
| 75 | -c{toxinidir}/etc/upper-constraints.onap.txt |
| 76 | commands = |
| 77 | pylint --max-line-length=120 --disable=missing-docstring --reports=y --score=y --output-format=colorized docs/conf.py |