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

Your project is now required to have a docs/index.rst so if you are
missing this file please create it.

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

diff --git a/.gitignore b/.gitignore
index 6fc2562..b21ec65 100644 (file)
--- a/.gitignore
+++ b/.gitignore
@@ -6,7 +6,6 @@
 /*.egg-info/
 .eggs/
 /build/
-/docs_build/
 /docs_output/
 /releng/
 /tests/*.img
@@ -16,3 +15,4 @@
 
 #Build results
 .tox
+docs/_build/*

diff --git a/docs/conf.py b/docs/conf.py
new file mode 100644 (file)
index 0000000..eb12e74
--- /dev/null
+++ b/docs/conf.py
@@ -0,0 +1 @@
+from docs_conf.conf import *  # noqa: F401,F403

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

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
index 832a1da..8a5df05 100644 (file)
--- a/tox.ini
+++ b/tox.ini
@@ -1,6 +1,6 @@
 [tox]
 minversion = 2.3.1
-envlist = py34, pep8
+envlist = py34, pep8,docs,docs-linkcheck
 skipsdist = True
 
 [testenv]
@@ -49,3 +49,14 @@ enable-extensions=H106,H203
 builtins = _
 filename = *.py,app.wsgi
 exclude=.venv,.git,.tox,dist,doc,*lib/python*,*egg,build,tests
+
+[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