From 47a6f470675ef28c5c7d5e9826fe6696fa139d14 Mon Sep 17 00:00:00 2001 From: Victor Morales Date: Wed, 9 Aug 2017 14:25:50 -0500 Subject: 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 --- bootstrap/vagrant-onap/tox.ini | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) (limited to 'bootstrap/vagrant-onap/tox.ini') 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 -- cgit 1.2.3-korg