X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Fguides%2Fonap-developer%2Fhow-to-use-docs%2Finclude-documentation.rst;h=6f5b0d46e3028d203c6423397ccb954e2be5a970;hb=1da95cb69c00bd64b550789c7d08c2449c6bcebf;hp=996d44e365d68d5eeb51b0b7b4ed6b29ed755c92;hpb=6688fd00ba150d6bd5c4e2f6cb91dd0c88fbf371;p=doc.git 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 996d44e36..6f5b0d46e 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 @@ -430,17 +430,27 @@ One Project ----------- To test how the documentation renders in HTML, follow these steps: -Install virtual environment. +Install `virtual environment `_ & create one. .. code-block:: bash sudo pip install virtualenv + virtualenv onap_docs + +Activate `onap_docs` virtual environment. + +.. code-block:: bash + + source onap_docs/bin/activate + +.. note:: Virtual environment activation has to be performed before attempting to build documentation. + Otherwise, tools necessary for the process might not be available. Download a project repository. .. code-block:: bash - git clone http://gerrit.onap.org/r/ + git clone http://gerrit.onap.org/r/ Download the doc repository. @@ -453,7 +463,7 @@ Change directory to doc & install requirements. .. code-block:: bash cd doc - sudo pip install -r etc/requirements.txt + pip install -r etc/requirements.txt Copy the conf.py file to your project folder where RST files have been kept: @@ -479,7 +489,7 @@ specified output folder directory. You can use your Web Browser to open and check resulting html pages in the output folder. -.. note:: Be sure to remove the `conf.py`, the static/ files and the output folder from the `/docs/`.This is for testing only. Only commit the rst files and related content. +.. note:: Be sure to remove the `conf.py`, the static/ files and the output folder from the `/docs/`. This is for testing only. Only commit the rst files and related content. .. _building-all-documentation: