tox.ini

   1 # vim: ts=4 expandtab sw=4:
   2 #==================================================================================
   3 #    Copyright (c) 2019 Nokia
   4 #    Copyright (c) 2018-2019 AT&T Intellectual Property.
   5 #
   6 #   Licensed under the Apache License, Version 2.0 (the "License");
   7 #   you may not use this file except in compliance with the License.
   8 #   You may obtain a copy of the License at
   9 #
  10 #       http://www.apache.org/licenses/LICENSE-2.0
  11 #
  12 #   Unless required by applicable law or agreed to in writing, software
  13 #   distributed under the License is distributed on an "AS IS" BASIS,
  14 #   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15 #   See the License for the specific language governing permissions and
  16 #   limitations under the License.
  17 #==================================================================================
  18
  19 # This is needed only to support the RTD scraper(s)
  20 #
  21 # CAUTION: requires python/tox and maybe others to be installed in the dev environment
  22 # to test with:
  23 #        tox -e docs
  24 #
  25 [tox]
  26 minversion = 2.0
  27 envlist =
  28     docs,
  29     docs-linkcheck,
  30 skipsdist = true
  31
  32 [testenv:docs]
  33 basepython = python3
  34 deps =
  35     sphinx
  36     sphinx-rtd-theme
  37     sphinxcontrib-httpdomain
  38     recommonmark
  39     lfdocs-conf
  40     urllib3~=1.26.15
  41 allowlist_externals = echo
  42 commands =
  43     sphinx-build -W -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
  44     echo "Generated docs available in {toxinidir}/docs/_build/html"
  45
  46 [testenv:docs-linkcheck]
  47 basepython = python3
  48 deps = sphinx
  49        sphinx-rtd-theme
  50        sphinxcontrib-httpdomain
  51        recommonmark
  52        lfdocs-conf
  53        urllib3~=1.26.15
  54 commands = sphinx-build -W -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck
  55