blob: 8684276f9736115df12e749408d6495327d59d0d [file] [log] [blame]
JosephKeenane68aec12022-09-01 11:39:47 +01001# ============LICENSE_START=======================================================
2# Copyright (C) 2022 Nordix Foundation
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# SPDX-License-Identifier: Apache-2.0
17# ============LICENSE_END=========================================================
18
Rishi.Chail5272dca2021-02-23 12:14:24 +000019[tox]
20minversion = 1.6
JosephKeenane68aec12022-09-01 11:39:47 +010021envlist = docs,docs-linkcheck,docs-spellcheck
Rishi.Chail5272dca2021-02-23 12:14:24 +000022skipsdist = true
Rishi.Chail5272dca2021-02-23 12:14:24 +000023[testenv:docs]
Cédric Ollivier0a86b482022-08-31 21:17:16 +020024basepython = python3.8
JosephKeenane68aec12022-09-01 11:39:47 +010025deps =
26 -r{toxinidir}/requirements-docs.txt
27 -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt
28 -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=master
Rishi.Chail5272dca2021-02-23 12:14:24 +000029commands =
Cédric Ollivier490b20d2023-03-15 21:40:48 +010030 sphinx-build -W -q -b html -n -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/html
Rishi.Chail5272dca2021-02-23 12:14:24 +000031[testenv:docs-linkcheck]
Cédric Ollivier0a86b482022-08-31 21:17:16 +020032basepython = python3.8
JosephKeenane68aec12022-09-01 11:39:47 +010033deps =
34 -r{toxinidir}/requirements-docs.txt
35 -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt
36 -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=master
37commands =
Cédric Ollivier490b20d2023-03-15 21:40:48 +010038 sphinx-build -W -q -b linkcheck -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/linkcheck
JosephKeenane68aec12022-09-01 11:39:47 +010039[testenv:docs-spellcheck]
40basepython = python3.8
41deps =
42 -r{toxinidir}/requirements-docs.txt
43 -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt
44 -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=master
45commands =
Cédric Ollivier490b20d2023-03-15 21:40:48 +010046 sphinx-build -b spelling -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/spellcheck