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
  17 [tox]
  18 envlist = docs,docs-linkcheck
  19 minversion = 2.0
  20 skipsdist = true
  21
  22 # doc jobs
  23 [testenv:docs]
  24 whitelist_externals = echo
  25 basepython = python3
  26 deps =
  27     sphinx
  28     sphinx-rtd-theme
  29     sphinxcontrib-httpdomain
  30     recommonmark
  31     lfdocs-conf
  32 commands =
  33     sphinx-build -W -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
  34     echo "Generated docs available in {toxinidir}/docs/_build/html"
  35
  36 [testenv:docs-linkcheck]
  37 skipsdist = true
  38 basepython = python3
  39 deps = sphinx
  40        sphinx-rtd-theme
  41        sphinxcontrib-httpdomain
  42        recommonmark
  43        lfdocs-conf
  44 commands = sphinx-build -W -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck