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: If257dec8d76d3ecf7d75e6cb4771dd9617db7fa4
Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>

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