From b100bc48371a85cdb2d6dd808e2f36088caf7359 Mon Sep 17 00:00:00 2001 From: Victor Morales Date: Wed, 7 Nov 2018 15:30:06 -0800 Subject: Add tox env to generate documentation The process to generate HTML documentation can be automated with tox. This chage covers the basics instructions. In order to test this is necessary to have python tox module and run the following command in the multivimbroker folder $ tox -e docs Change-Id: I9540f6234a85e4775a482efd9dda9da1ec615591 Signed-off-by: Victor Morales Issue-ID: DOC-300 --- multivimbroker/tox.ini | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'multivimbroker') diff --git a/multivimbroker/tox.ini b/multivimbroker/tox.ini index af3b3a5..1e54370 100644 --- a/multivimbroker/tox.ini +++ b/multivimbroker/tox.ini @@ -32,3 +32,7 @@ deps = rstcheck whitelist_externals = bash commands = bash -c "find ../docs -not -path {toxinidir}/.tox/\* \ -name \*.rst -type f -print0 | xargs -0 rstcheck --report warning" + +[testenv:docs] +deps = sphinx +commands = sphinx-build -b html ../docs/ ../docs/html -- cgit 1.2.3-korg