Local Documentation Builds

This adds configuration for performing local documentation builds with the following simple command: tox -e docs Change-Id: Id07d11951e9fb4812737574884ff505bf536b221 Signed-off-by: Aric Gardner <[email protected]>
opnfv · Sep 18, 2018 · 478dc53 · 478dc53
1 parent b52c942
commit 478dc53
Show file tree

Hide file tree

Showing 5 changed files with 25 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
@@ -1,11 +1,12 @@
 *~
 *.sw?
 *.pyc
-/docs_build/
 /docs_output/
 /releng/
 *.egg-info/
 .*project
 .settings
 build
 dist
+.tox
+docs/_build/*
diff --git a/docs/conf.py b/docs/conf.py
@@ -0,0 +1 @@
+from docs_conf.conf import *
diff --git a/docs/conf.yaml b/docs/conf.yaml
@@ -0,0 +1,3 @@
+---
+project_cfg: opnfv
+project: BAROMETER
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -0,0 +1,2 @@
+lfdocs-conf
+sphinx_opnfv_theme
diff --git a/tox.ini 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