tox.ini

   1 #  ============LICENSE_START===============================================
   2 #  Copyright (C) 2023 Nordix Foundation. All rights reserved.
   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 #  ============LICENSE_END=================================================
  16 #
  17
  18 # documentation only
  19 [tox]
  20 minversion = 2.0
  21 envlist =
  22     docs,
  23     docs-linkcheck,
  24 skipsdist = true
  25
  26 [testenv:docs]
  27 basepython = python3
  28 deps = -r{toxinidir}/docs/requirements-docs.txt
  29
  30 commands =
  31     sphinx-build -W -b html -n -d {envtmpdir}/docs/doctrees ./docs/ {toxinidir}/docs/_build/html
  32     echo "Generated docs available in {toxinidir}/docs/_build/html"
  33 allowlist_externals = echo
  34
  35 [testenv:docs-linkcheck]
  36 basepython = python3
  37 deps = -r{toxinidir}/docs/requirements-docs.txt
  38 commands = sphinx-build -W -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck