diff options
| -rw-r--r-- | docs/guides/onap-developer/how-to-use-docs/include-documentation.rst | 18 | ||||
| m--------- | docs/submodules/ccsdk/features.git | 0 | ||||
| m--------- | docs/submodules/clamp.git | 0 | ||||
| m--------- | docs/submodules/logging-analytics.git | 0 | ||||
| m--------- | docs/submodules/multicloud/framework.git | 0 | ||||
| m--------- | docs/submodules/policy/parent.git | 0 | ||||
| m--------- | docs/submodules/vfc/nfvo/lcm.git | 0 |
7 files changed, 14 insertions, 4 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 6909cceb1..d61cb9cff 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 @@ -427,17 +427,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 +460,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 +486,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: diff --git a/docs/submodules/ccsdk/features.git b/docs/submodules/ccsdk/features.git -Subproject 7bbcdbb841d81217e6a341a6eeaa8c6fda8daf4 +Subproject 59f80ce1dff01ec4700aeaefab956a4ee1e81d3 diff --git a/docs/submodules/clamp.git b/docs/submodules/clamp.git -Subproject 7c7323d8ec54e65ac7a9a5e8c7cd8bdc755ea70 +Subproject e44fdb1905fae612b12b56886af8f387e516e48 diff --git a/docs/submodules/logging-analytics.git b/docs/submodules/logging-analytics.git -Subproject 8699c6606de31c116cd45f2fc74f048a5e3f397 +Subproject e5ecc985d2e1272fe5b587f86d2b4bfc733e089 diff --git a/docs/submodules/multicloud/framework.git b/docs/submodules/multicloud/framework.git -Subproject bbfe2fbdfa9488bb7c464c55c328a9488a21524 +Subproject c5bacb8c02da8ef280359b0c492468403f89fda diff --git a/docs/submodules/policy/parent.git b/docs/submodules/policy/parent.git -Subproject 760cce91689a00a52de363c96745323fb95a91b +Subproject 7fd4a6ee280b40916d5438b4bd4e2c5a8e043f1 diff --git a/docs/submodules/vfc/nfvo/lcm.git b/docs/submodules/vfc/nfvo/lcm.git -Subproject d9949426185df3323dea4db239293328c539580 +Subproject 1757a7e0f63f892200d680bb228db19ec993d1a |