summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorStephen Wong <stephen.kf.wong@gmail.com>2018-09-19 20:53:34 +0000
committerGerrit Code Review <gerrit@opnfv.org>2018-09-19 20:53:34 +0000
commite716285dfe01e2373984550495fd2cf02dbf959d (patch)
tree1b124dd88bdbf5387c9089be163b6930327466eb
parente8eaf48f2a1230658e38eb8d609bdcd31b3661fd (diff)
parentda30cab5f4d52037fa46a06347286d455000d8c7 (diff)
Merge "Local Documentation Builds"
-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, 24 insertions, 1 deletions
diff --git a/.gitignore b/.gitignore
index e2075ec..8370460 100644
--- 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
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..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
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