Merge "Document temporary character of references in repolist.rst"

[doc.git] / docs / guides / onap-developer / how-to-use-docs / include-documentation.rst

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 996d44e..6f5b0d4 100644 (file)
--- 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:
 
 -----------
 To test how the documentation renders in HTML, follow these steps:
 

-Install virtual environment.
+Install `virtual environment <https://pypi.org/project/virtualenv>`_ & create one.

 
 .. code-block:: bash
 
    sudo pip install virtualenv
 
 .. 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
 
 
 Download a project repository.
 
 .. code-block:: bash
 

-  git clone http://gerrit.onap.org/r/<project>
+   git clone http://gerrit.onap.org/r/<project>

 
 Download the doc repository.
 
 
 Download the doc repository.
 


@@ -453,7 +463,7 @@ Change directory to doc & install requirements.
 .. code-block:: bash
 
    cd doc
 .. 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:
 
 
 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.
 
 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 `<project>/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 `<project>/docs/`. This is for testing only. Only commit the rst files and related content.

 
 .. _building-all-documentation:
 
 
 .. _building-all-documentation: