Enable Local Docs builds by using LF Docs Conf

The docs-conf[1] project will allow releng to have local docs builds using the OPNFV theme while also not needing to duplicate the opnfvdocs conf.py file. [1] https://github.com/lfit/releng-docs-conf Change-Id: I255faf045eccb363993af9dfb81b487e538cbb41 Signed-off-by: Trevor Bramwell <[email protected]>
opnfv · Apr 20, 2018 · 3affc96 · 3affc96
1 parent 8d84d7d
commit 3affc96
Show file tree

Hide file tree

Showing 5 changed files with 20 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
@@ -5,6 +5,7 @@
 /releng/
 .idea
 *.py[cod]
+docs/_build/
 
 .Python
 env/

diff --git a/docs/conf.py b/docs/conf.py
@@ -0,0 +1 @@
+from docs_conf.conf import *  # flake8: noqa
diff --git a/docs/conf.yaml b/docs/conf.yaml
@@ -0,0 +1,3 @@
+---
+project_cfg: opnfv
+project: releng
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -0,0 +1,3 @@
+lfdocs-conf
+sphinxcontrib-httpdomain
+sphinx-opnfv-theme
diff --git a/tox.ini b/tox.ini
@@ -4,7 +4,7 @@
 # and then run "tox" from this directory.
 
 [tox]
-envlist = py27
+envlist = jjb,docs,docs-linkcheck
 skipsdist = True
 
 [testenv]
@@ -18,3 +18,14 @@ deps =
   jenkins-job-builder==1.6.1
 commands=
   jenkins-jobs test -o job_output -r jjb/global:{posargs:"jjb/"}
+
+[testenv:docs]
+deps = -r{toxinidir}/docs/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 = -r{toxinidir}/docs/requirements.txt
+commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./docs {toxinidir}/docs/_build/linkcheck
-Original file line number
+Diff line change
@@ Expand Up / @@ -5,6 +5,7 @@ @@
     /releng/
     .idea
     *.py[cod]
+    docs/_build/
     .Python
     env/
@@ Expand Down @@