From: Eric Debeau Date: Fri, 12 Jul 2019 12:11:33 +0000 (+0000) Subject: Merge "Removing submodules for apex & distribution" X-Git-Tag: elalto.1.5.2~1956 X-Git-Url: https://gerrit.onap.org/r/gitweb?a=commitdiff_plain;h=62669bfe57ad0c9ea19f6fe4690d6a50f1201178;hp=3af44a96b56d216fa418ef9eb05722c5d856e1a0;p=doc.git Merge "Removing submodules for apex & distribution" --- 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 `_ & 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. @@ -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 `/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: diff --git a/docs/submodules/ccsdk/features.git b/docs/submodules/ccsdk/features.git index 7bbcdbb84..59f80ce1d 160000 --- a/docs/submodules/ccsdk/features.git +++ b/docs/submodules/ccsdk/features.git @@ -1 +1 @@ -Subproject commit 7bbcdbb841d81217e6a341a6eeaa8c6fda8daf46 +Subproject commit 59f80ce1dff01ec4700aeaefab956a4ee1e81d3e diff --git a/docs/submodules/clamp.git b/docs/submodules/clamp.git index 7c7323d8e..e44fdb190 160000 --- a/docs/submodules/clamp.git +++ b/docs/submodules/clamp.git @@ -1 +1 @@ -Subproject commit 7c7323d8ec54e65ac7a9a5e8c7cd8bdc755ea70a +Subproject commit e44fdb1905fae612b12b56886af8f387e516e485 diff --git a/docs/submodules/logging-analytics.git b/docs/submodules/logging-analytics.git index 8699c6606..e5ecc985d 160000 --- a/docs/submodules/logging-analytics.git +++ b/docs/submodules/logging-analytics.git @@ -1 +1 @@ -Subproject commit 8699c6606de31c116cd45f2fc74f048a5e3f397c +Subproject commit e5ecc985d2e1272fe5b587f86d2b4bfc733e0893 diff --git a/docs/submodules/multicloud/framework.git b/docs/submodules/multicloud/framework.git index bbfe2fbdf..c5bacb8c0 160000 --- a/docs/submodules/multicloud/framework.git +++ b/docs/submodules/multicloud/framework.git @@ -1 +1 @@ -Subproject commit bbfe2fbdfa9488bb7c464c55c328a9488a215247 +Subproject commit c5bacb8c02da8ef280359b0c492468403f89fda3 diff --git a/docs/submodules/policy/parent.git b/docs/submodules/policy/parent.git index 760cce916..7fd4a6ee2 160000 --- a/docs/submodules/policy/parent.git +++ b/docs/submodules/policy/parent.git @@ -1 +1 @@ -Subproject commit 760cce91689a00a52de363c96745323fb95a91b0 +Subproject commit 7fd4a6ee280b40916d5438b4bd4e2c5a8e043f13 diff --git a/docs/submodules/vfc/nfvo/lcm.git b/docs/submodules/vfc/nfvo/lcm.git index d99494261..1757a7e0f 160000 --- a/docs/submodules/vfc/nfvo/lcm.git +++ b/docs/submodules/vfc/nfvo/lcm.git @@ -1 +1 @@ -Subproject commit d9949426185df3323dea4db239293328c5395808 +Subproject commit 1757a7e0f63f892200d680bb228db19ec993d1a2