From cfcabcdc552514702740f5f69c62b5e799b9f24b Mon Sep 17 00:00:00 2001
From: Aric Gardner <agardner@linuxfoundation.org>
Date: Tue, 18 Sep 2018 12:10:43 -0400
Subject: Local Documentation Builds

This adds configuration for performing local documentation builds
with the following simple command:

tox -e docs

This patch is part of our documentation effor to Move away from submodules
https://docs.opnfv.org/en/latest/how-to-use-docs/local-build-transition.html

added index.rst so that docs build succsesfully

Change-Id: I2d28f03ad4d5c9c14de095dc544257af9d1e51d9
Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
(cherry picked from commit 9666d8bb3df726d88d08d5811d2a99e713908396)
---
 tox.ini | 12 +++++++++++-
 1 file changed, 11 insertions(+), 1 deletion(-)

(limited to 'tox.ini')

diff --git a/tox.ini b/tox.ini
index 4d9ed626..f69881ed 100644
--- a/tox.ini
+++ b/tox.ini
@@ -1,5 +1,5 @@
 [tox]
-envlist = docs,pep8,pylint,py35
+envlist = docs,docs-linkcheck,pep8,pylint,py35
 
 [testenv]
 usedevelop = True
@@ -24,3 +24,13 @@ commands = flake8 --exclude .build,build --ignore=F401
 [testenv:py35]
 basepython = python3
 
+[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