blob: d676879d3b4f840b060ce1d0fd0bc80ad31e2ea5 [file] [log] [blame]
elinuxhenrik9a104852022-10-20 15:29:36 +02001# ==================================================================================
2# Copyright (c) 2022 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]
19minversion = 2.0
20envlist =
21 docs,
22 docs-linkcheck,
23skipsdist = true
24
25[testenv:docs]
26basepython = python3
27deps = -r{toxinidir}/docs/requirements-docs.txt
28
29commands =
30 sphinx-build -W -b html -n -d {envtmpdir}/docs/doctrees ./docs/ {toxinidir}/docs/_build/html
31 echo "Generated docs available in {toxinidir}/docs/_build/html"
JohnKeeney7ae570a2023-04-27 10:20:13 +010032allowlist_externals = echo
elinuxhenrik9a104852022-10-20 15:29:36 +020033
34[testenv:docs-linkcheck]
35basepython = python3
36deps = -r{toxinidir}/docs/requirements-docs.txt
37commands = sphinx-build -W -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck