From: JohnKeeney Date: Fri, 28 Jun 2024 17:25:07 +0000 (+0100) Subject: Docs - reenable j-release checks after first rtd build (j-release branch) X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=commitdiff_plain;h=refs%2Fheads%2Fj-release;p=nonrtric%2Fplt%2Frappmanager.git Docs - reenable j-release checks after first rtd build (j-release branch) Issue-ID: NONRTRIC-972 Change-Id: I435fe626c9fd95ec5103e7b6266632195d7b7fd2 Signed-off-by: JohnKeeney --- diff --git a/.gitignore b/.gitignore index a44c9cd..438d918 100755 --- a/.gitignore +++ b/.gitignore @@ -3,6 +3,7 @@ target/ !.mvn/wrapper/maven-wrapper.jar !**/src/main/**/target/ !**/src/test/**/target/ +docs/_build/ ### STS ### .apt_generated diff --git a/docs/conf.py b/docs/conf.py index 0f0f5b3..4daa501 100755 --- a/docs/conf.py +++ b/docs/conf.py @@ -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 = ["*"] diff --git a/docs/overview.rst b/docs/overview.rst index 486232b..364b671 100755 --- a/docs/overview.rst +++ b/docs/overview.rst @@ -45,7 +45,8 @@ List of participants used by rApp manager sample rApp. * `A1PMS Participant `_ - It interacts with A1PMS of NONRTRIC. It is capable of lifecycle managing A1PMS service. * `Kserve Participant `_ - It interacts with Kserve. It is capable of lifecycle managing Kserve inference service. * `Kubernetes Participant `_ - 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 ` - 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 --- 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