tox.ini

   1 # ==================================================================================
   2 #       Copyright (c) 2020 Nordix
   3 #
   4 #   Licensed under the Apache License, Version 2.0 (the "License");
   5 #   you may not use this file except in compliance with the License.
   6 #   You may obtain a copy of the License at
   7 #
   8 #          http://www.apache.org/licenses/LICENSE-2.0
   9 #
  10 #   Unless required by applicable law or agreed to in writing, software
  11 #   distributed under the License is distributed on an "AS IS" BASIS,
  12 #   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13 #   See the License for the specific language governing permissions and
  14 #   limitations under the License.
  15 # ==================================================================================
  16 [tox]
  17 envlist = docs,docs-linkcheck
  18 minversion = 2.0
  19 skipsdist = true
  20
  21 # doc jobs
  22 [testenv:docs]
  23 whitelist_externals = echo
  24 basepython = python3
  25 deps =
  26     sphinx
  27     sphinx-rtd-theme
  28     sphinxcontrib-httpdomain
  29     recommonmark
  30     lfdocs-conf
  31 commands =
  32     sphinx-build -W -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
  33     echo "Generated docs available in {toxinidir}/docs/_build/html"
  34
  35 [testenv:docs-linkcheck]
  36 skipsdist = true
  37 basepython = python3
  38 deps = sphinx
  39        sphinx-rtd-theme
  40        sphinxcontrib-httpdomain
  41        recommonmark
  42        lfdocs-conf
  43 commands = sphinx-build -W -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck