tox.ini

   1 # This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 # SPDX-License-Identifier: CC-BY-4.0
   3 # Copyright (C) 2019 AT&T Intellectual Property
   4 # documentation only
   5
   6 [tox]
   7 minversion = 2.0
   8 envlist =
   9     docs,
  10     docs-linkcheck,
  11 skipsdist = true
  12
  13 [testenv:docs]
  14 basepython = python3
  15 deps =
  16     sphinx
  17     sphinx-rtd-theme
  18     sphinxcontrib-httpdomain
  19     recommonmark
  20     lfdocs-conf
  21     urllib3~=1.26.15
  22
  23 allowlist_externals = echo
  24
  25 commands =
  26     sphinx-build -W -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
  27     echo "Generated docs available in {toxinidir}/docs/_build/html"
  28
  29 [testenv:docs-linkcheck]
  30 basepython = python3
  31 deps = sphinx
  32        sphinx-rtd-theme
  33        sphinxcontrib-httpdomain
  34        recommonmark
  35        lfdocs-conf
  36        urllib3~=1.26.15
  37
  38 commands = sphinx-build -W -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck