From: Eric Debeau <eric.debeau@orange.com>
Date: Fri, 12 Jul 2019 15:39:52 +0000 (+0000)
Subject: Merge "Document temporary character of references in repolist.rst"
X-Git-Tag: elalto.1.5.2~1944
X-Git-Url: https://gerrit.onap.org/r/gitweb?a=commitdiff_plain;h=1da95cb69c00bd64b550789c7d08c2449c6bcebf;hp=-c;p=doc.git

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

1da95cb69c00bd64b550789c7d08c2449c6bcebf
diff --combined docs/guides/onap-developer/how-to-use-docs/include-documentation.rst
index d61cb9cff,996d44e36..6f5b0d46e
--- a/docs/guides/onap-developer/how-to-use-docs/include-documentation.rst
+++ b/docs/guides/onap-developer/how-to-use-docs/include-documentation.rst
@@@ -51,7 -51,10 +51,10 @@@ login to gerrit or for git clone reques
  The next step is to add a directory in the doc project where your
  project will be included as a submodule and at least one reference
  from the doc project to the documentation index in your repository.
- The following sequence will do this over ssh.
+ The following sequence will do this over ssh. Please note that the
+ reference to your project in *repolist.rst* should be considered
+ temporary and removed when you reference it from more appropriate
+ place.
  
  .. caution::
  
@@@ -427,27 -430,17 +430,27 @@@ One Projec
  -----------
  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
 +   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/<project>
 +   git clone http://gerrit.onap.org/r/<project>
  
  Download the doc repository.
  
@@@ -460,7 -453,7 +463,7 @@@ Change directory to doc & install requi
  .. 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:
  
@@@ -486,7 -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 `<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: