summaryrefslogtreecommitdiffstats
path: root/tox.ini
diff options
context:
space:
mode:
authorAric Gardner <agardner@linuxfoundation.org>2018-09-18 11:06:02 -0400
committermbeierl <mark.beierl@dell.com>2018-09-18 14:28:25 -0400
commitf2548eacf2ae70f90bf486714fabf09a11d5d15d (patch)
treeba645015fed7a08fd3feb4cbb85f6617e2e427ca /tox.ini
parent5f84c19c4511da6706a501308b509aacbc6219de (diff)
Local Documentation Builds
This adds configuration for performing local documentation builds with the following simple command: tox -e docs Change-Id: I8d7b3af60c12f4d426e3d6fc64eae66b356d94a6 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