From 72c03e11197ad3eb9a532d9605bd64a6f9d82050 Mon Sep 17 00:00:00 2001
From: Aric Gardner <agardner@linuxfoundation.org>
Date: Tue, 18 Sep 2018 11:05:26 -0400
Subject: 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: Ib0c7626c37b7f733641fcf2174d9951bf2371886
Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
---
 tox.ini | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)
 create mode 100644 tox.ini

(limited to 'tox.ini')

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
-- 
cgit 1.2.3-korg