diff options
Diffstat (limited to 'docs')
31 files changed, 19 insertions, 8 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: diff --git a/docs/release/repolist.rst b/docs/release/repolist.rst index e75abf195..9f59f0027 100644 --- a/docs/release/repolist.rst +++ b/docs/release/repolist.rst @@ -78,7 +78,7 @@ Project/Components integration <../submodules/integration.git/docs/index> msb/discovery <../submodules/msb/discovery.git/docs/index> msb/java-sdk <../submodules/msb/java-sdk.git/docs/index> - policy/apex-pdp <../submodules/policy/apex-pdp.git/docs/index> + policy/parent <../submodules/policy/parent.git/docs/index> sdc/jtosca <../submodules/sdc/jtosca.git/docs/index> sdc/sdc-distribution-client <../submodules/sdc/sdc-distribution-client.git/docs/index> sdc/sdc-docker-base <../submodules/sdc/sdc-docker-base.git/docs/index> diff --git a/docs/submodules/aai/sparky-be.git b/docs/submodules/aai/sparky-be.git -Subproject d2a7058c50537fdf3406a417218db5607b23eff +Subproject da2fd730ddb9a21965ac77829fd2bbd50c36c43 diff --git a/docs/submodules/appc.git b/docs/submodules/appc.git -Subproject d368feb33cf3dcf1008b060503b7a41edef67e9 +Subproject b1d55dd69c4a1b808b2a2ab995172e4bfdabfae diff --git a/docs/submodules/ccsdk/cds.git b/docs/submodules/ccsdk/cds.git -Subproject e827a3aee231453f704fef1a945d13de380a83c +Subproject 7d58591a2dd41b9e2655f5d06a1eb344146d8e7 diff --git a/docs/submodules/ccsdk/distribution.git b/docs/submodules/ccsdk/distribution.git -Subproject b5b816769e0fd6f3068c13eb004ad2ca95b9cd9 +Subproject 9f4fd319d2f04b401f28ddd9790f3ea41754f9b diff --git a/docs/submodules/ccsdk/features.git b/docs/submodules/ccsdk/features.git -Subproject 7bbcdbb841d81217e6a341a6eeaa8c6fda8daf4 +Subproject 104f65e0fd4cb9c6b411e77f7c81e3d82c89680 diff --git a/docs/submodules/ccsdk/parent.git b/docs/submodules/ccsdk/parent.git -Subproject 322f4ffd1216bd01bde2b0f0f4c310811df1c12 +Subproject 6073799f2b75c716b44e818f7c3a8b914deea47 diff --git a/docs/submodules/ccsdk/platform/plugins.git b/docs/submodules/ccsdk/platform/plugins.git -Subproject 6b5636fe2ddaab95d180876127701e71639faf7 +Subproject d7275e776cbfa0484d82700bdabf47da91b4611 diff --git a/docs/submodules/clamp.git b/docs/submodules/clamp.git -Subproject 7c7323d8ec54e65ac7a9a5e8c7cd8bdc755ea70 +Subproject e44fdb1905fae612b12b56886af8f387e516e48 diff --git a/docs/submodules/dmaap/datarouter.git b/docs/submodules/dmaap/datarouter.git -Subproject cec9a9227c805ff5415d6b9fd913fa64adafdd3 +Subproject 98572b78fcce9ff28fa7429c9265812bd1e78bf diff --git a/docs/submodules/integration.git b/docs/submodules/integration.git -Subproject 3adfd35f7946e0ff31870fe69ab7f43d127303b +Subproject e781c7c4e4e385f504254d0fd32f534d559af3c diff --git a/docs/submodules/logging-analytics.git b/docs/submodules/logging-analytics.git -Subproject 8699c6606de31c116cd45f2fc74f048a5e3f397 +Subproject 58389c5f0afee416211e1fcb02c456c5ba10aee diff --git a/docs/submodules/msb/apigateway.git b/docs/submodules/msb/apigateway.git -Subproject 18352a47ee8f6e4fbb499dc1eee20587b1e5343 +Subproject faabc5c70fd285d3698d45516841f99459a89be diff --git a/docs/submodules/multicloud/azure.git b/docs/submodules/multicloud/azure.git -Subproject 8ab92dba524aacc4956497d72f6aa1b25ceb1ad +Subproject 833696479f69255cd58eb5cfe7b729e15a640fe diff --git a/docs/submodules/multicloud/framework.git b/docs/submodules/multicloud/framework.git -Subproject 96bb41e64271accc719a49736bb9a2c89c49f25 +Subproject c5bacb8c02da8ef280359b0c492468403f89fda diff --git a/docs/submodules/multicloud/k8s.git b/docs/submodules/multicloud/k8s.git -Subproject 8445148cf095fcc55a9ada3e2bb0fece7a06508 +Subproject 7ff99668b98aae1210f72e84fcc130581456360 diff --git a/docs/submodules/oom.git b/docs/submodules/oom.git -Subproject 1b9848822827bcf68f5573ab2b664b8c73ef0f7 +Subproject 887a978cd68c4cf826b5b2f535e43c0eef11dbe diff --git a/docs/submodules/optf/cmso.git b/docs/submodules/optf/cmso.git -Subproject e8aaf9e7a6dbe61f1508c6b7f04fa9b14f2e4c7 +Subproject 8d79b30fed898ede2b551a579e3564cb196f707 diff --git a/docs/submodules/policy/apex-pdp.git b/docs/submodules/policy/apex-pdp.git deleted file mode 160000 -Subproject 5c384fb2888029c2babb859c30318749e1ce828 diff --git a/docs/submodules/policy/distribution.git b/docs/submodules/policy/distribution.git deleted file mode 160000 -Subproject d1e0acb7a85403e365764589327b9aef6250931 diff --git a/docs/submodules/policy/parent.git b/docs/submodules/policy/parent.git -Subproject 0c56e114555b17818d2ee03bb680f27df8158ad +Subproject 7fd4a6ee280b40916d5438b4bd4e2c5a8e043f1 diff --git a/docs/submodules/portal.git b/docs/submodules/portal.git -Subproject f26978caa8e8aa870c47032a2adb5284a71a72b +Subproject 73248465fc2867a3dd1a6494afb6b0774c9028f diff --git a/docs/submodules/sdc.git b/docs/submodules/sdc.git -Subproject 57844f30fc90a9b5007180c2da7a06977942d4f +Subproject c8fcbbc2a9cc964ba1d4b872562b8f418504730 diff --git a/docs/submodules/sdc/jtosca.git b/docs/submodules/sdc/jtosca.git -Subproject 6018fb047963d151d77bf03f6f84446866a3089 +Subproject 787ef0b09708ba160efa81e507fd8d0bc6719f4 diff --git a/docs/submodules/sdc/sdc-distribution-client.git b/docs/submodules/sdc/sdc-distribution-client.git -Subproject eb47236253465eaf1ad92313f799f4e399c2491 +Subproject 19c8bdce471587972861d395149564950f0d4a4 diff --git a/docs/submodules/sdc/sdc-tosca.git b/docs/submodules/sdc/sdc-tosca.git -Subproject d8147920f168eddb65722543054cafe06f5bf20 +Subproject 0414d985162bad8bad29a1e0527b84a3ff6c0aa diff --git a/docs/submodules/so.git b/docs/submodules/so.git -Subproject 781ae827294edc8e9a25d1ac83d7399be8186e8 +Subproject 4f7af8bab030fc3d331816a706dd0a9e2974c45 diff --git a/docs/submodules/vfc/nfvo/lcm.git b/docs/submodules/vfc/nfvo/lcm.git -Subproject b0a05961ea9bc959a675615d19c0f234b161c67 +Subproject 1757a7e0f63f892200d680bb228db19ec993d1a diff --git a/docs/submodules/vid.git b/docs/submodules/vid.git -Subproject 58d22b526418ffeb89337fed9e20406da420bc6 +Subproject 7befef8d013fb9e5627a50f7fb1e1937eb27e48 |