blob: 25da5d74691d4f50dd80c81ef388795f7f4a3ba8 [file] [log] [blame]
seanbeirnea67e7352022-10-25 17:36:55 +01001# ============LICENSE_START=======================================================
2# Copyright (C) 2021 Bell Canada
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
shivasubedi3d1579c2021-09-13 16:43:20 +010019[tox]
20minversion = 1.6
seanbeirnea67e7352022-10-25 17:36:55 +010021envlist = docs,docs-linkcheck,docs-spellcheck
shivasubedi3d1579c2021-09-13 16:43:20 +010022skipsdist = true
shivasubedi3d1579c2021-09-13 16:43:20 +010023[testenv:docs]
mpriyank7b7297c2022-09-14 10:47:45 +010024basepython = python3.8
seanbeirnea67e7352022-10-25 17:36:55 +010025deps =
26 -r{toxinidir}/requirements-docs.txt
thmsdt344e5462024-02-27 11:25:18 +010027 -chttps://releases.openstack.org/constraints/upper/yoga
seanbeirnea67e7352022-10-25 17:36:55 +010028 -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=master
shivasubedi3d1579c2021-09-13 16:43:20 +010029commands =
seanbeirnea67e7352022-10-25 17:36:55 +010030 sphinx-build -W -q -b html -n -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/html
shivasubedi3d1579c2021-09-13 16:43:20 +010031[testenv:docs-linkcheck]
mpriyank7b7297c2022-09-14 10:47:45 +010032basepython = python3.8
seanbeirnea67e7352022-10-25 17:36:55 +010033deps =
34 -r{toxinidir}/requirements-docs.txt
thmsdt344e5462024-02-27 11:25:18 +010035 -chttps://releases.openstack.org/constraints/upper/yoga
seanbeirnea67e7352022-10-25 17:36:55 +010036 -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=master
37commands =
38 sphinx-build -W -q -b linkcheck -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/linkcheck
39[testenv:docs-spellcheck]
40basepython = python3.8
41deps =
42 -r{toxinidir}/requirements-docs.txt
thmsdt344e5462024-02-27 11:25:18 +010043 -chttps://releases.openstack.org/constraints/upper/yoga
seanbeirnea67e7352022-10-25 17:36:55 +010044 -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=master
45commands =
halil.cakal73a51342023-03-20 10:33:08 +000046 sphinx-build -b spelling -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/spellcheck