Docs - reenable j-release checks after first rtd build (j-release branch) 39/13139/1 j-release
authorJohnKeeney <john.keeney@est.tech>
Fri, 28 Jun 2024 17:25:07 +0000 (18:25 +0100)
committerJohnKeeney <john.keeney@est.tech>
Fri, 28 Jun 2024 17:25:13 +0000 (18:25 +0100)
Issue-ID: NONRTRIC-972
Change-Id: I435fe626c9fd95ec5103e7b6266632195d7b7fd2
Signed-off-by: JohnKeeney <john.keeney@est.tech>
.gitignore
docs/conf.py
docs/overview.rst
tox.ini

index a44c9cd..438d918 100755 (executable)
@@ -3,6 +3,7 @@ target/
 !.mvn/wrapper/maven-wrapper.jar
 !**/src/main/**/target/
 !**/src/test/**/target/
+docs/_build/
 
 ### STS ###
 .apt_generated
index 0f0f5b3..4daa501 100755 (executable)
@@ -46,5 +46,5 @@ redoc_uri = 'https://cdn.jsdelivr.net/npm/redoc@next/bundles/redoc.standalone.js
 intersphinx_mapping = {}
 
 intersphinx_mapping['nonrtric'] = ('%s/o-ran-sc-nonrtric/en/%s' %(baseurl, branch), None)
-#intersphinx_mapping['participants'] = ('%s/participants' % selfurl, None)
+intersphinx_mapping['participants'] = ('%s/participants' % selfurl, None)
 intersphinx_disabled_reftypes = ["*"]
index 486232b..364b671 100755 (executable)
@@ -45,7 +45,8 @@ List of participants used by rApp manager sample rApp.
 * `A1PMS Participant <https://docs.onap.org/projects/onap-policy-parent/en/latest/clamp/acm/design-impl/participants/a1pms-participant.html>`_ - It interacts with A1PMS of NONRTRIC. It is capable of lifecycle managing A1PMS service.
 * `Kserve Participant <https://docs.onap.org/projects/onap-policy-parent/en/latest/clamp/acm/design-impl/participants/kserve-participant.html>`_ - It interacts with Kserve. It is capable of lifecycle managing Kserve inference service.
 * `Kubernetes Participant <https://docs.onap.org/projects/onap-policy-parent/en/latest/clamp/acm/design-impl/participants/k8s-participant.html>`_ - It interacts with Helm/Kubernetes. It is capable of lifecycle managing Helm charts. It expects the helm charts to be available in the mentioned repository as it doesn't handle the helm chart creation in the chart repository.
-
+* :doc:`DME Participant <participants:index>` -  It interacts with DME(ICS) of NONRTRIC. It is capable of lifecycle managing DME entities.
+  
 ACM composition and instance details can be provided as part of the rApp package and the package structure can be found in `Sample rApp package structure`_.
 
 DME
diff --git a/tox.ini b/tox.ini
index b211725..1b63bfc 100755 (executable)
--- a/tox.ini
+++ b/tox.ini
@@ -36,11 +36,11 @@ commands =
 
 allowlist_externals = echo
 
-#[testenv:docs-linkcheck]
-#basepython = python3
-#deps =
-#    -r{toxinidir}/docs/requirements-docs.txt
-#    -r{toxinidir}/participants/docs/requirements-docs.txt
-#commands =
-#    sphinx-build -W -b linkcheck -d {envtmpdir}/participants/doctrees ./participants/docs/ {toxinidir}/docs/_build/linkcheck/participants
-#    sphinx-build -W -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck
+[testenv:docs-linkcheck]
+basepython = python3
+deps =
+    -r{toxinidir}/docs/requirements-docs.txt
+    -r{toxinidir}/participants/docs/requirements-docs.txt
+commands =
+    sphinx-build -W -b linkcheck -d {envtmpdir}/participants/doctrees ./participants/docs/ {toxinidir}/docs/_build/linkcheck/participants
+    sphinx-build -W -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck