diff options
| author |   Victor Morales <victor.morales@intel.com> | 2017-08-09 14:25:50 -0500 |
|---|---|---|
| committer | Victor Morales <victor.morales@intel.com> | 2017-08-09 14:25:50 -0500 |
| commit | 47a6f470675ef28c5c7d5e9826fe6696fa139d14 (patch) | |
| tree | 1b0763fb7be9c95c911611683a02979f39237694 /bootstrap/vagrant-onap/tox.ini | |
| parent | bafd0b7a83b442983e3736af71da28f45b03b9ff (diff) | |
Improve vagrant-onap documentation
It was added the process to create documentation thru sphinx tool.
Now it's possible to generate all the documentation locally running:
$ tox -e docs
Lastly, the installation guide was included as a reference to
different methods to install requirements.
Change-Id: Id0b277d605cf83ddbde54ecd9f4648e1f89023c3
Signed-off-by: Victor Morales <victor.morales@intel.com>
Diffstat (limited to 'bootstrap/vagrant-onap/tox.ini')
| -rw-r--r-- | bootstrap/vagrant-onap/tox.ini | 11 |
1 files changed, 7 insertions, 4 deletions
diff --git a/bootstrap/vagrant-onap/tox.ini b/bootstrap/vagrant-onap/tox.ini index 02fccf58d..674810006 100644 --- a/bootstrap/vagrant-onap/tox.ini +++ b/bootstrap/vagrant-onap/tox.ini @@ -9,17 +9,20 @@ usedevelop = False install_command = pip install {opts} {packages} [testenv:bashate] -# if you want to test out some changes you have made to bashate -# against devstack, just set BASHATE_INSTALL_PATH=/path/... to your -# modified bashate tree deps = - {env:BASHATE_INSTALL_PATH:bashate==0.5.1} + {env:BASHATE_INSTALL_PATH:bashate} whitelist_externals = bash commands = bash -c "find {toxinidir}/{tests,lib,tools} \ -not \( -type d -path *files* -prune \) \ + -not \( -type f -name .*.swp* -prune \) \ + -not \( -type f -name *.ps1 -prune \) \ -type f \ # E005 file does not begin with #! or have a .sh prefix # E006 check for lines longer than 79 columns # E042 local declaration hides errors # E043 Arithmetic compound has inconsistent return semantics -print0 | xargs -0 bashate -v -iE006 -eE005,E042,E043" + +[testenv:docs] +deps = sphinx +commands = sphinx-build -W -b html doc/source doc/build/html |