X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;ds=sidebyside;f=tox.ini;h=b1dea1670a510fbe7708883ddab55471c6ac50c2;hb=5d03d73461d916f037d50e0e44d5cf77885a4778;hp=dc7c0bf84a1295658b8ea66a5a863fc931a169da;hpb=4de8b081b1d461e5435fea66705789d141d93ad4;p=doc.git diff --git a/tox.ini b/tox.ini index dc7c0bf84..b1dea1670 100644 --- a/tox.ini +++ b/tox.ini @@ -1,13 +1,16 @@ [tox] minversion = 1.6 -envlist = docs +envlist = docs,docs-linkcheck skipsdist = true [testenv:docs] basepython = python3 -deps = -r{toxinidir}/etc/requirements.txt +deps = + -r{toxinidir}/etc/requirements.txt + -c{toxinidir}/etc/upper-constraints.os.txt + -c{toxinidir}/etc/upper-constraints.onap.txt commands = - sphinx-build -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html + sphinx-build -W -q -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html echo "Generated docs available in {toxinidir}/docs/_build/html" whitelist_externals = echo @@ -16,24 +19,47 @@ whitelist_externals = [testenv:local] basepython = python3 -deps = -r{toxinidir}/etc/requirements.txt +deps = + -r{toxinidir}/etc/requirements.txt + -c{toxinidir}/etc/upper-constraints.os.txt + -c{toxinidir}/etc/upper-constraints.onap.txt commands = git submodule update --depth 100 --init - sphinx-build -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html + sphinx-build -q -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 -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck +deps = + -r{toxinidir}/etc/requirements.txt + -c{toxinidir}/etc/upper-constraints.os.txt + -c{toxinidir}/etc/upper-constraints.onap.txt +commands = sphinx-build -q -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 + -c{toxinidir}/etc/upper-constraints.os.txt + -c{toxinidir}/etc/upper-constraints.onap.txt +commands = + sphinx-build -b spelling -Dextensions=sphinxcontrib.spelling -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/spellcheck + +[testenv:autopep8] +deps = + -r{toxinidir}/etc/requirements.txt + -c{toxinidir}/etc/upper-constraints.os.txt + -c{toxinidir}/etc/upper-constraints.onap.txt +commands = + autopep8 --max-line-length 120 --in-place docs/conf.py + +[testenv:pylint] +deps = + -r{toxinidir}/etc/requirements.txt + -c{toxinidir}/etc/upper-constraints.os.txt + -c{toxinidir}/etc/upper-constraints.onap.txt +commands = + pylint --max-line-length=120 --disable=missing-docstring --reports=y --score=y --output-format=colorized docs/conf.py