From 77ea445fc757efa8e57d0490d6bcb5e1e1715eb2 Mon Sep 17 00:00:00 2001 From: ShubhamRathi Date: Fri, 27 Jan 2017 00:40:19 +0530 Subject: New Tox build script 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 --- etc/requirements.txt | 1 + tox.ini | 15 +++++++++++++++ 2 files changed, 16 insertions(+) create mode 100644 tox.ini diff --git a/etc/requirements.txt b/etc/requirements.txt index bc49b3a02..8ad711f2a 100644 --- a/etc/requirements.txt +++ b/etc/requirements.txt @@ -1,3 +1,4 @@ +tox Sphinx==1.3.1 doc8 docutils diff --git a/tox.ini b/tox.ini new file mode 100644 index 000000000..c1993d9ee --- /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 -- cgit 1.2.3-korg