blob: 1eb2928acf98a769d055804656bb6560c41221ea [file] [log] [blame]
vlad shkapenyuk9b604ae2019-11-11 15:29:31 -05001#==================================================================================
2# Copyright (c) 2018-2019 AT&T Intellectual Property.
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[tox]
18minversion = 2.0
19envlist =
20 docs,
21 docs-linkcheck,
22
23skipsdist = true
24
25[testenv:docs]
26basepython = python3
27deps =
28 sphinx
29 sphinx-rtd-theme
30 sphinxcontrib-httpdomain
31 recommonmark
32 lfdocs-conf
33
34commands =
35 sphinx-build -W -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
36
37 echo "Generated docs available in {toxinidir}/docs/_build/html"
38
39whitelist_externals = echo
40
41[testenv:docs-linkcheck]
42basepython = python3
43deps = sphinx
44 sphinx-rtd-theme
45 sphinxcontrib-httpdomain
46 recommonmark
47 lfdocs-conf
48commands = sphinx-build -W -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck