New Tox build script 31/27631/1
authorShubhamRathi <shubhamiiitbackup@gmail.com>
Thu, 26 Jan 2017 19:10:19 +0000 (00:40 +0530)
committerShubhamRathi <shubhamiiitbackup@gmail.com>
Thu, 26 Jan 2017 19:10:19 +0000 (00:40 +0530)
To keep the doc jobs for OPNFV & ODL as similar as possible, we're
using a similar tox build script as used in ODLDocs.  The new merge
job is tested to run the same tox build script.  This build script
is to be run as `tox -edocs`. Everything under docs/ shall be built.

Change-Id: Ic4fab5e431e6937a1dbbeca2b1ff339dd092b688
Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
etc/requirements.txt
tox.ini [new file with mode: 0644]

index bc49b3a..8ad711f 100644 (file)
@@ -1,3 +1,4 @@
+tox
 Sphinx==1.3.1
 doc8
 docutils
diff --git a/tox.ini b/tox.ini
new file mode 100644 (file)
index 0000000..c1993d9
--- /dev/null
+++ b/tox.ini
@@ -0,0 +1,15 @@
+[tox]
+minversion = 1.6
+envlist = docs,docs-linkcheck
+skipsdist = true
+
+[testenv:docs]
+deps = -r{toxinidir}/etc/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}/etc/requirements.txt
+commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck
\ No newline at end of file