Fix RTD job - att #3 79/13879/1 2.9.0
authorJohnKeeney <john.keeney@est.tech>
Mon, 16 Dec 2024 17:18:36 +0000 (17:18 +0000)
committerJohnKeeney <john.keeney@est.tech>
Mon, 16 Dec 2024 17:18:42 +0000 (17:18 +0000)
Issue-ID: NONRTRIC-1041
Change-Id: Id36aaa20a9e314e2db20c9e3cd998f43804e8840
Signed-off-by: JohnKeeney <john.keeney@est.tech>
.readthedocs.yaml
docs/api-docs.rst
docs/conf.py
docs/developer-guide.rst
docs/installation-guide.rst

index de0fead..e34d4bb 100644 (file)
@@ -27,9 +27,12 @@ build:
   tools:
     python: "3.11"
   jobs:
-    post_build:
-      - mkdir -p ${READTHEDOCS_OUTPUT}html/openapi
-      - cp -v -r docs/offeredapis/openapitoolgen/offeredapis/pms-api/* ${READTHEDOCS_OUTPUT}html/openapi
+    pre_build:
+      - mkdir --parents _readthedocs/html/
+      - mkdir --parents _readthedocs/html/offeredapis/pms-api/
+      - mkdir --parents _readthedocs/tmp/doctrees
+      - sphinx-build -W -b html --keep-going -n -d _readthedocs/tmp/doctrees  ./docs/ _readthedocs/html/
+      - cp -v -r ./docs/offeredapis/openapitoolgen/offeredapis/pms-api/* _readthedocs/html/offeredapis/pms-api/
 
 python:
   install:
index 0f0b289..8aeb6dd 100644 (file)
@@ -13,6 +13,6 @@ To view the Open API specification for A1 PMS, please see the following.
 .. raw:: html
 
     <ul>
-    <li><a href="./pms-api.html">A1 Policy Management Service API and SDK Documentation</a></li>
-    <li><a href="./v3/index.html">A1 Policy Management Service API version 3 and SDK Documentation</a></li>
+    <li><a href="./offeredapis/pms-api/index.html">A1 Policy Management Service API and SDK Documentation</a></li>
+    <li><a href="./offeredapis/pms-api/v3/index.html">A1 Policy Management Service API version 3 (R1-AP) and SDK Documentation</a></li>
     </ul>
index 437bd21..cb43b80 100644 (file)
@@ -32,7 +32,7 @@ linkcheck_ignore = [
 extensions = ['sphinx.ext.intersphinx',]
 
 html_extra_path = [
-    'offeredapis/openapitoolgen/offeredapis/pms-api'
+    'offeredapis/openapitoolgen'
 ]
 
 #intershpinx mapping with other projects
index 9106726..665686b 100644 (file)
@@ -17,7 +17,7 @@ Docker & Kubernetes deployment
 ==============================
 
 Information on running and configuring the functions in Docker can be found 
-on the `Run in Docker wiki page <https://wiki.o-ran-sc.org/display/RICNR/Release+J+-+Run+in+Docker>`_
+on the `Run in Docker wiki page <https://lf-o-ran-sc.atlassian.net/wiki/spaces/RICNR/pages/86802677/Release+K+-+Run+in+Docker>`_
 
 Non-RT RIC can be also deployed in a Kubernetes cluster, `it/dep repository <https://gerrit.o-ran-sc.org/r/admin/repos/it/dep>`_.
 hosts deployment and integration artifacts. Instructions and helm charts to deploy the Non-RT-RIC functions in the
@@ -26,6 +26,6 @@ OSC NONRTRIC integrated test environment can be found in the *./nonrtric* direct
 For more information see `Integration and Testing documentation on the O-RAN-SC wiki <https://docs.o-ran-sc.org/projects/o-ran-sc-it-dep>`_.
 
 For more information on installation of NonRT-RIC in Kubernetes, 
-see `Deploy NONRTRIC functions in Kubernetes <https://wiki.o-ran-sc.org/display/RICNR/Release+J+-+Run+in+Kubernetes>`_.
+see `Deploy NONRTRIC functions in Kubernetes <https://lf-o-ran-sc.atlassian.net/wiki/spaces/RICNR/pages/86802787/Release+K+-+Run+in+Kubernetes>`_.
 
 
index d720c1a..d36cbe0 100644 (file)
@@ -18,13 +18,13 @@ Install with Docker
 +++++++++++++++++++
 
 Information on running and configuring the functions in Docker can be found 
-on the `Run in Docker wiki page <https://wiki.o-ran-sc.org/display/RICNR/Release+J+-+Run+in+Docker>`_
+on the `Run in Docker wiki page <https://lf-o-ran-sc.atlassian.net/wiki/spaces/RICNR/pages/86802677/Release+K+-+Run+in+Docker>`_
 
 Install with Helm
 +++++++++++++++++
 
 Information on running and configuring the functions in Kubernetes can be found 
-on the `Run in Kubernetes wiki page <https://wiki.o-ran-sc.org/display/RICNR/Release+J+-+Run+in+Kubernetes>`_
+on the `Run in Kubernetes wiki page <https://lf-o-ran-sc.atlassian.net/wiki/spaces/RICNR/pages/86802787/Release+K+-+Run+in+Kubernetes>`_
 
 Helm charts and an example recipe are provided in the `it/dep repo <https://gerrit.o-ran-sc.org/r/admin/repos/it/dep>`_,
 under "nonrtric". By modifying the variables named "installXXX" in the beginning of the example recipe file, which