blob: 92aa4b29ef4c0d198383ef2d4cd6ec81daa1e908 [file] [log] [blame]
Bruno Sakotoff7d57a2021-09-07 18:21:59 -04001# ============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
19[tox]
20minversion = 1.6
21envlist = docs
22skipsdist = true
23
24[testenv:docs]
25basepython = python3
Cédric Ollivier508a72a2021-10-15 09:41:53 +020026deps = -r{toxinidir}/requirements.txt
lukegleeson4e502792021-09-30 11:01:48 +010027 -chttps://git.onap.org/doc/plain/etc/upper-constraints.os.txt
28 -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt
Bruno Sakotoff7d57a2021-09-07 18:21:59 -040029commands =
Cédric Ollivier508a72a2021-10-15 09:41:53 +020030 sphinx-build -b html -n -d {envtmpdir}/docs/doctrees ./docs {toxinidir}/docs/_build/html
31 echo "Generated docs available in {toxinidir}/docs/_build/html"
Bruno Sakotoff7d57a2021-09-07 18:21:59 -040032whitelist_externals =
33 echo
34 git
35 sh
36
37[testenv:docs-linkcheck]
38basepython = python3
Cédric Ollivier508a72a2021-10-15 09:41:53 +020039deps = -r{toxinidir}/requirements.txt
lukegleeson4e502792021-09-30 11:01:48 +010040 -chttps://git.onap.org/doc/plain/etc/upper-constraints.os.txt
41 -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt
Bruno Sakotoff7d57a2021-09-07 18:21:59 -040042commands = echo "Link Checking not enforced"
43whitelist_externals =
44 echo