tox.ini

   1 [tox]
   2 minversion = 1.6
   3 envlist = docs,docs-linkcheck
   4 skipsdist = true
   5
   6 [testenv:docs]
   7 basepython = python3
   8 deps = -r{toxinidir}/etc/requirements.txt
   9 commands =
  10     sphinx-build -W -q -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
  11     echo "Generated docs available in {toxinidir}/docs/_build/html"
  12 whitelist_externals =
  13     echo
  14     git
  15     sh
  16
  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
  26 [testenv:local]
  27 basepython = python3
  28 deps = -r{toxinidir}/etc/requirements.txt
  29 commands =
  30     git submodule update --depth 100 --init
  31     sphinx-build -q -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
  32     echo "Generated docs available in {toxinidir}/docs/_build/html"
  33 whitelist_externals =
  34     echo
  35     git
  36
  37 [testenv:docs-linkcheck]
  38 basepython = python3
  39 deps = -r{toxinidir}/etc/requirements.txt
  40 commands = sphinx-build -q -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck
  41
  42 [testenv:spellcheck]
  43 basepython = python3
  44 deps =
  45     -r{toxinidir}/etc/requirements.txt
  46     sphinxcontrib-spelling
  47 commands =
  48     sphinx-build -b spelling -Dextensions=sphinxcontrib.spelling -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/spellcheck
  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