| # This work is licensed under a Creative Commons Attribution 4.0 International License. |
| # SPDX-License-Identifier: CC-BY-4.0 |
| # Copyright (C) 2020 AT&T Intellectual Property |
| # documentation only |
| |
| # this file is needed to control the read the docs verification mechanism in jenkins |
| |
| [tox] |
| minversion = 2.0 |
| envlist = |
| docs, |
| docs-linkcheck, |
| skipsdist = true |
| |
| [testenv:docs] |
| basepython = python3 |
| deps = |
| sphinx |
| sphinx-rtd-theme |
| sphinxcontrib-httpdomain |
| recommonmark |
| lfdocs-conf |
| |
| commands = |
| sphinx-build -W -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html |
| echo "Generated docs available in {toxinidir}/docs/_build/html" |
| whitelist_externals = echo |
| |
| [testenv:docs-linkcheck] |
| basepython = python3 |
| deps = sphinx |
| sphinx-rtd-theme |
| sphinxcontrib-httpdomain |
| recommonmark |
| lfdocs-conf |
| commands = sphinx-build -W -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck |
| |