diff options
Diffstat (limited to 'docs/guides/onap-developer')
| -rw-r--r-- | docs/guides/onap-developer/developing/index.rst | 2 | ||||
| -rw-r--r-- | docs/guides/onap-developer/how-to-use-docs/include-documentation.rst | 23 |
2 files changed, 18 insertions, 7 deletions
diff --git a/docs/guides/onap-developer/developing/index.rst b/docs/guides/onap-developer/developing/index.rst index b88790e92..567f5b095 100644 --- a/docs/guides/onap-developer/developing/index.rst +++ b/docs/guides/onap-developer/developing/index.rst @@ -247,8 +247,6 @@ Policy Framework ../../../submodules/policy/parent.git/docs/index ../../../submodules/policy/engine.git/docs/index - ../../../submodules/policy/apex-pdp.git/docs/index - ../../../submodules/policy/distribution.git/docs/index Portal Platform --------------- 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 6909cceb1..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 @@ -51,7 +51,10 @@ login to gerrit or for git clone requests over ssh. 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,17 +430,27 @@ One Project ----------- 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. @@ -450,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: @@ -476,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: |