summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAaron Smith <aasmith@redhat.com>2018-09-19 23:23:26 +0000
committerGerrit Code Review <gerrit@opnfv.org>2018-09-19 23:23:26 +0000
commitec05bfdf4721bec6abab0b912cee721c5cc54e1d (patch)
tree398fa90afba3ee7fff49161b6c6e5189a56aa258
parente7f7e9226f2370afe0d57b4c43c5bfe4bf30a942 (diff)
parent478dc53bfdda4aec04045302f1c3f822cbfc12a5 (diff)
Merge "Local Documentation Builds"HEADmaster
-rw-r--r--.gitignore3
-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, 1 deletions
diff --git a/.gitignore b/.gitignore
index 292d8c3..aa762ea 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,7 +1,6 @@
*~
*.sw?
*.pyc
-/docs_build/
/docs_output/
/releng/
*.egg-info/
@@ -9,3 +8,5 @@
.settings
build
dist
+.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..cba650f
--- /dev/null
+++ b/docs/conf.yaml
@@ -0,0 +1,3 @@
+---
+project_cfg: opnfv
+project: BAROMETER
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