X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=tox.ini;h=5807a81800d79591c3ab8aec9eda567325496756;hb=b620d675152ed844cae68c62140d010470ca9d39;hp=574ff4e397184497ae33e6ae6b7da5b8fda1852e;hpb=07f71c372948c1f90a26a286830cda049a6025c4;p=doc.git diff --git a/tox.ini b/tox.ini index 574ff4e39..5807a8180 100644 --- a/tox.ini +++ b/tox.ini @@ -1,32 +1,49 @@ [tox] minversion = 1.6 -envlist = docs +envlist = docs,docs-linkcheck skipsdist = true [testenv:docs] +basepython = python3 deps = -r{toxinidir}/etc/requirements.txt commands = - sphinx-build -j 3 -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html + sphinx-build -W -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html echo "Generated docs available in {toxinidir}/docs/_build/html" -whitelist_externals = echo +whitelist_externals = + echo + git + sh [testenv:local] +basepython = python3 deps = -r{toxinidir}/etc/requirements.txt commands = - git submodule update --depth 1 --init - sphinx-build -j 4 -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html + git submodule update --depth 100 --init + sphinx-build -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html echo "Generated docs available in {toxinidir}/docs/_build/html" whitelist_externals = echo git -[testenv:linkcheck] +[testenv:docs-linkcheck] +basepython = python3 deps = -r{toxinidir}/etc/requirements.txt -commands = sphinx-build -j 4 -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck +commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck [testenv:spellcheck] +basepython = python3 deps = -r{toxinidir}/etc/requirements.txt sphinxcontrib-spelling -commands = - sphinx-build -b spelling -Dextensions=sphinxcontrib.spelling -Dspelling_word_list_filename=validwords.txt -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/spellcheck +commands = + sphinx-build -b spelling -Dextensions=sphinxcontrib.spelling -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/spellcheck + +[testenv:autopep8] +deps = autopep8 +commands = + autopep8 --max-line-length 120 --in-place docs/conf.py + +[testenv:pylint] +deps = pylint +commands = + pylint --max-line-length=120 --disable=missing-docstring --reports=y --score=y --output-format=colorized docs/conf.py