summaryrefslogtreecommitdiffstats
path: root/tox.ini
diff options
context:
space:
mode:
authorAric Gardner <agardner@linuxfoundation.org>2018-09-18 11:05:47 -0400
committerAric Gardner <agardner@linuxfoundation.org>2018-09-28 16:20:33 -0400
commit1ec589de26715445aeff3e565693f71e472e3496 (patch)
tree9ed003463ca5a4ffcad813d4ef3f1478119a5e79 /tox.ini
parent0dacfaa2fbd2dfe7fc9d438b9350a0187506e61c (diff)
Local Documentation Builds
This adds configuration for performing local documentation builds with the following simple command: tox -e docs added index.rst so that docs build succsesfully Change-Id: Iab747c90f7f4b7866270c5850b2792e194b5378a Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
Diffstat (limited to 'tox.ini')
-rw-r--r--tox.ini17
1 files changed, 17 insertions, 0 deletions
diff --git a/tox.ini b/tox.ini
new file mode 100644
index 0000000..69aa189
--- /dev/null
+++ b/tox.ini
@@ -0,0 +1,17 @@
+[tox]
+minversion = 1.6
+envlist =
+ docs,
+ docs-linkcheck
+skipsdist = true
+
+[testenv:docs]
+deps = -rdocs/requirements.txt
+commands =
+ sphinx-build -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]
+deps = -rdocs/requirements.txt
+commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck