summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAric Gardner <agardner@linuxfoundation.org>2018-09-18 11:05:55 -0400
committerAric Gardner <agardner@linuxfoundation.org>2018-09-18 11:06:01 -0400
commitd2b2482561359abaeed12b77ccd8ad4418dffd8a (patch)
tree670a8aaeeaf83f922f59a33bb3c65eda915a5fd9
parentd65e22d27ab305d38059046dae60d7a66ff4a4e0 (diff)
Local Documentation Builds
This adds configuration for performing local documentation builds with the following simple command: tox -e docs Change-Id: I68d939d6b1c7e27fc5d266d0934e355560ee7748 Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
-rw-r--r--.gitignore2
-rw-r--r--docs/conf.py1
-rw-r--r--docs/conf.yaml3
-rw-r--r--docs/requirements.txt2
-rw-r--r--tox.ini17
5 files changed, 25 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..71d7636
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,2 @@
+.tox
+docs/_build/*
diff --git a/docs/conf.py b/docs/conf.py
new file mode 100644
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
index 0000000..6c3acad
--- /dev/null
+++ b/docs/conf.yaml
@@ -0,0 +1,3 @@
+---
+project_cfg: opnfv
+project: STOR4NFV
diff --git a/docs/requirements.txt b/docs/requirements.txt
new file mode 100644
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
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