tox.ini

   1 [tox]
   2 minversion = 1.6
   3 envlist = docs,
   4 #         docs-linkcheck,
   5
   6 skipsdist = true
   7
   8 [testenv:docs]
   9 basepython = python3
  10 deps =
  11     -r{toxinidir}/etc/requirements.txt
  12     -c{toxinidir}/etc/upper-constraints.os.txt
  13     -c{toxinidir}/etc/upper-constraints.onap.txt
  14 commands =
  15     sphinx-build -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
  16     echo "Generated docs available in {toxinidir}/docs/_build/html"
  17 whitelist_externals =
  18     echo
  19     git
  20     sh
  21
  22 [testenv:local]
  23 basepython = python3
  24 deps =
  25     -r{toxinidir}/etc/requirements.txt
  26     -c{toxinidir}/etc/upper-constraints.os.txt
  27     -c{toxinidir}/etc/upper-constraints.onap.txt
  28 commands =
  29     git submodule update --depth 100 --init
  30     sphinx-build -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
  31     echo "Generated docs available in {toxinidir}/docs/_build/html"
  32 whitelist_externals =
  33     echo
  34     git
  35
  36 [testenv:docs-linkcheck]
  37 basepython = python3
  38 deps =
  39     -r{toxinidir}/etc/requirements.txt
  40     -c{toxinidir}/etc/upper-constraints.os.txt
  41     -c{toxinidir}/etc/upper-constraints.onap.txt
  42 commands = echo "Link Checking not enforced"
  43 #commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck
  44 whitelist_externals =
  45     echo
  46
  47 [testenv:spellcheck]
  48 basepython = python3
  49 deps =
  50     -r{toxinidir}/etc/requirements.txt
  51     -c{toxinidir}/etc/upper-constraints.os.txt
  52     -c{toxinidir}/etc/upper-constraints.onap.txt
  53 commands =
  54     sphinx-build -b spelling -Dextensions=sphinxcontrib.spelling -Dspelling_word_list_filename=validwords.txt -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/spellcheck