diff options
| author |   Victor Morales <victor.morales@intel.com> | 2018-11-07 15:30:06 -0800 |
|---|---|---|
| committer | Victor Morales <victor.morales@intel.com> | 2018-11-07 15:33:05 -0800 |
| commit | b100bc48371a85cdb2d6dd808e2f36088caf7359 (patch) | |
| tree | 955f6d9c9823e1a13c7fdfb512a1ebcfc3f2302a /multivimbroker/tox.ini | |
| parent | 66b38dea91018952d9070d95dcc29fe510e13a1a (diff) | |
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 <victor.morales@intel.com>
Issue-ID: DOC-300
Diffstat (limited to 'multivimbroker/tox.ini')
| -rw-r--r-- | multivimbroker/tox.ini | 4 |
1 files changed, 4 insertions, 0 deletions
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 |