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}/requirements.txt
  10     -chttps://git.onap.org/doc/plain/etc/upper-constraints.os.txt
  11     -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt
  12 commands =
  13     sphinx-build -W -q -b html -n -d {envtmpdir}/docs/doctrees {toxinidir}/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:docs-templates]
  21 basepython = python3
  22 deps =
  23     -r{toxinidir}/requirements.txt
  24     -chttps://git.onap.org/doc/plain/etc/upper-constraints.os.txt
  25     -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt
  26 commands =
  27     sphinx-build -b html -n -d {envtmpdir}/doctrees -c {toxinidir}/docs/ {toxinidir}/docs/guides/onap-developer/how-to-use-docs/templates {toxinidir}/_build/templates
  28     echo "Generated docs available in {toxinidir}/_build/html/templates"
  29 whitelist_externals =
  30     echo
  31
  32 [testenv:local]
  33 basepython = python3
  34 deps =
  35     -r{toxinidir}/requirements.txt
  36     -chttps://git.onap.org/doc/plain/etc/upper-constraints.os.txt
  37     -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt
  38 commands =
  39     git submodule update --depth 100 --init
  40     sphinx-build -q -b html -n -d {envtmpdir}/doctrees {toxinidir}/docs {toxinidir}/docs/_build/html
  41     echo "Generated docs available in {toxinidir}/docs/_build/html"
  42 whitelist_externals =
  43     echo
  44     git
  45
  46 [testenv:docs-linkcheck]
  47 basepython = python3
  48 deps =
  49     -r{toxinidir}/requirements.txt
  50     -chttps://git.onap.org/doc/plain/etc/upper-constraints.os.txt
  51     -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt
  52 commands = sphinx-build -q -b linkcheck -d {envtmpdir}/doctrees {toxinidir}/docs {toxinidir}/docs/_build/linkcheck
  53
  54 [testenv:spellcheck]
  55 basepython = python3
  56 deps =
  57     -r{toxinidir}/requirements.txt
  58     -chttps://git.onap.org/doc/plain/etc/upper-constraints.os.txt
  59     -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt
  60 commands =
  61     sphinx-build -b spelling -Dextensions=sphinxcontrib.spelling -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/docs/_build/spellcheck
  62
  63 [testenv:autopep8]
  64 deps =
  65     -r{toxinidir}/requirements.txt
  66     -chttps://git.onap.org/doc/plain/etc/upper-constraints.os.txt
  67     -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt
  68 commands =
  69     autopep8 --max-line-length 120 --in-place {toxinidir}/docs/conf.py
  70
  71 [testenv:pylint]
  72 deps =
  73     -r{toxinidir}/requirements.txt
  74     -chttps://git.onap.org/doc/plain/etc/upper-constraints.os.txt
  75     -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt
  76 commands =
  77     pylint --max-line-length=120 --disable=missing-docstring --reports=y --score=y  --output-format=colorized {toxinidir}/docs/conf.py