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 =
   9     -r{toxinidir}/etc/requirements.txt
  10     -c{toxinidir}/etc/upper-constraints.os.txt
  11     -c{toxinidir}/etc/upper-constraints.onap.txt
  12 commands =
  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"
  15 whitelist_externals =
  16     echo
  17     git
  18     sh
  19
  20 [testenv:local]
  21 basepython = python3
  22 deps =
  23     -r{toxinidir}/etc/requirements.txt
  24     -c{toxinidir}/etc/upper-constraints.os.txt
  25     -c{toxinidir}/etc/upper-constraints.onap.txt
  26 commands =
  27     git submodule update --depth 100 --init
  28     sphinx-build -q -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
  29     echo "Generated docs available in {toxinidir}/docs/_build/html"
  30 whitelist_externals =
  31     echo
  32     git
  33
  34 [testenv:docs-linkcheck]
  35 basepython = python3
  36 deps =
  37     -r{toxinidir}/etc/requirements.txt
  38     -c{toxinidir}/etc/upper-constraints.os.txt
  39     -c{toxinidir}/etc/upper-constraints.onap.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     -c{toxinidir}/etc/upper-constraints.os.txt
  47     -c{toxinidir}/etc/upper-constraints.onap.txt
  48 commands =
  49     sphinx-build -b spelling -Dextensions=sphinxcontrib.spelling -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/spellcheck
  50
  51 [testenv:autopep8]
  52 deps =
  53     -r{toxinidir}/etc/requirements.txt
  54     -c{toxinidir}/etc/upper-constraints.os.txt
  55     -c{toxinidir}/etc/upper-constraints.onap.txt
  56 commands =
  57     autopep8 --max-line-length 120 --in-place docs/conf.py
  58
  59 [testenv:pylint]
  60 deps =
  61     -r{toxinidir}/etc/requirements.txt
  62     -c{toxinidir}/etc/upper-constraints.os.txt
  63     -c{toxinidir}/etc/upper-constraints.onap.txt
  64 commands =
  65     pylint --max-line-length=120 --disable=missing-docstring --reports=y --score=y  --output-format=colorized docs/conf.py