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) 2020 AT&T Intellectual Property
   4 # documentation only
   5
   6 # this file is needed to control the read the docs verification mechanism in jenkins
   7
   8 [tox]
   9 minversion = 2.0
  10 envlist =
  11     docs,
  12     docs-linkcheck,
  13 skipsdist = true
  14
  15 [testenv:docs]
  16 basepython = python3
  17 deps =
  18     sphinx
  19     sphinx-rtd-theme
  20     sphinxcontrib-httpdomain
  21     recommonmark
  22     lfdocs-conf
  23
  24 commands =
  25     sphinx-build -W -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
  26     echo "Generated docs available in {toxinidir}/docs/_build/html"
  27 whitelist_externals = echo
  28
  29 [testenv:docs-linkcheck]
  30 basepython = python3
  31 deps = sphinx
  32        sphinx-rtd-theme
  33        sphinxcontrib-httpdomain
  34        recommonmark
  35        lfdocs-conf
  36 commands = sphinx-build -W -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck
  37