tox.ini

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