diff options
| author |   Cédric Ollivier <cedric.ollivier@orange.com> | 2017-11-10 11:31:53 +0100 |
|---|---|---|
| committer | Cédric Ollivier <cedric.ollivier@orange.com> | 2017-11-13 10:47:34 +0100 |
| commit | 268209ca8ec9d70f2e403da00663b50342902a71 (patch) | |
| tree | 1424142935adf04bbf9f701559df04f3aaced516 | |
| parent | efd9cdf09bcdfadf956d383a2e224ae2ff5ef76a (diff) | |
Pull submodules when running tox
Otherwise it only works via jjobs but tox is also designed for users.
It creates a new venv to ease testing it before integrating in jjobs.
The documentation is updated as well to refer to the new venv.
Issue-ID: DOC-159
Change-Id: Ida2ad14ebcf54ab776c2439dd83e74364432af46
Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com>
| -rw-r--r-- | docs/guides/onap-developer/how-to-use-docs/include-documentation.rst | 12 | ||||
| -rw-r--r-- | tox.ini | 10 |
2 files changed, 12 insertions, 10 deletions
diff --git a/docs/guides/onap-developer/how-to-use-docs/include-documentation.rst b/docs/guides/onap-developer/how-to-use-docs/include-documentation.rst index 4a7300d16..15d71d453 100644 --- a/docs/guides/onap-developer/how-to-use-docs/include-documentation.rst +++ b/docs/guides/onap-developer/how-to-use-docs/include-documentation.rst @@ -390,23 +390,15 @@ Download the DOC repository. git clone http://gerrit.onap.org/r/doc -Change directory to docs & install requirements. - -.. code-block:: bash - - cd doc - sudo pip install -r etc/requirements.txt - Update submodules, build documentation using tox & then open using any browser. .. code-block:: bash cd doc - git submodule update --depth 1 --init - tox -edocs + tox -elocal firefox docs/_build/html/index.html -.. note:: Make sure to run `tox -edocs` and not just `tox`. +.. note:: Make sure to run `tox -elocal` and not just `tox`. @@ -10,6 +10,16 @@ commands = echo "Generated docs available in {toxinidir}/docs/_build/html" whitelist_externals = echo +[testenv:local] +deps = -r{toxinidir}/etc/requirements.txt +commands = + git submodule update --depth 1 --init + sphinx-build -j 4 -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html + echo "Generated docs available in {toxinidir}/docs/_build/html" +whitelist_externals = + echo + git + [testenv:docs-linkcheck] deps = -r{toxinidir}/etc/requirements.txt commands = sphinx-build -j 4 -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck |