1 # ==================================================================================
2 # Copyright (c) 2022 Nordix
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
8 # http://www.apache.org/licenses/LICENSE-2.0
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 # ==================================================================================
18 envlist = docs,docs-linkcheck
24 whitelist_externals = echo
25 # Version 3.8 is required, otherwise AttributeError will arise
26 basepython = python3.8
30 sphinxcontrib-httpdomain
31 # Version 0.6.0 is required, otherwise BlockGrammer error will arise
32 sphinxcontrib-openapi==0.6.0
36 sphinx-build -W -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
37 echo "Generated docs available in {toxinidir}/docs/_build/html"
39 [testenv:docs-linkcheck]
41 basepython = python3.8
44 sphinxcontrib-httpdomain
45 # Version 0.6.0 is required, otherwise BlockGrammer error will arise
46 sphinxcontrib-openapi==0.6.0
49 commands = sphinx-build -W -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck