blob: 1b63bfc740b54b2562dc117e646412df8ec208b5 [file] [log] [blame]
aravind.est3d9c2002023-10-23 13:46:39 +01001# ============LICENSE_START===============================================
2# Copyright (C) 2023 Nordix Foundation. All rights reserved.
aravind.est1f825722023-11-30 14:37:34 +00003# Copyright (C) 2023 OpenInfra Foundation Europe. All rights reserved.
aravind.est3d9c2002023-10-23 13:46:39 +01004# ========================================================================
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]
21minversion = 2.0
22envlist =
23 docs,
24 docs-linkcheck,
25skipsdist = true
26
27[testenv:docs]
28basepython = python3
aravind.est1f825722023-11-30 14:37:34 +000029deps =
30 -r{toxinidir}/docs/requirements-docs.txt
31 -r{toxinidir}/participants/docs/requirements-docs.txt
aravind.est3d9c2002023-10-23 13:46:39 +010032
33commands =
aravind.est1f825722023-11-30 14:37:34 +000034 sphinx-build -W -b html --keep-going -n -d {envtmpdir}/participants/doctrees ./participants/docs/ {toxinidir}/docs/_build/html/participants
aravind.est3d9c2002023-10-23 13:46:39 +010035 sphinx-build -W -b html -n -d {envtmpdir}/docs/doctrees ./docs/ {toxinidir}/docs/_build/html
aravind.est1f825722023-11-30 14:37:34 +000036
aravind.est3d9c2002023-10-23 13:46:39 +010037allowlist_externals = echo
38
39[testenv:docs-linkcheck]
40basepython = python3
aravind.est1f825722023-11-30 14:37:34 +000041deps =
42 -r{toxinidir}/docs/requirements-docs.txt
43 -r{toxinidir}/participants/docs/requirements-docs.txt
44commands =
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