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