Local Documentation Builds

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

    tox -e docs

Change-Id: Ifb8fce66e59432863d042a96308e6c3a89fb11a8
Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>

diff --git a/.gitignore b/.gitignore
index e2075ec..8370460 100644 (file)
--- a/.gitignore
+++ b/.gitignore
@@ -26,7 +26,6 @@ dist/
 .testrepository/
 cover/
 .*.sw?
-/docs_build/
 /docs_output/
 /docs/apidocs/yardstick*.rst
 #PyCharm IDE project configuration files
@@ -36,3 +35,4 @@ cover/
 # work env
 work/
 .pytest_cache
+docs/_build/*

diff --git a/docs/conf.py b/docs/conf.py
new file mode 100644 (file)
index 0000000..3c4453e
--- /dev/null
+++ b/docs/conf.py
@@ -0,0 +1 @@
+from docs_conf.conf import *

diff --git a/docs/conf.yaml b/docs/conf.yaml
new file mode 100644 (file)
index 0000000..f871056
--- /dev/null
+++ b/docs/conf.yaml
@@ -0,0 +1,3 @@
+---
+project_cfg: opnfv
+project: CLOVER

diff --git a/docs/requirements.txt b/docs/requirements.txt
new file mode 100644 (file)
index 0000000..9fde2df
--- /dev/null
+++ b/docs/requirements.txt
@@ -0,0 +1,2 @@
+lfdocs-conf
+sphinx_opnfv_theme

diff --git a/tox.ini b/tox.ini
new file mode 100644 (file)
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