NONRTRIC-998: Servicemanager - Add API Docs

Issue-ID: NONRTRIC-998
Change-Id: I8ed5e0506293fe6df743a4676b27b2f16fbc0029
Signed-off-by: DenisGNoonan <denis.noonan@est.tech>

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
index 95da239..3fd1760 100644 (file)
--- a/.readthedocs.yaml
+++ b/.readthedocs.yaml
@@ -1,5 +1,6 @@
 #  ============LICENSE_START===============================================
 #  Copyright (C) 2022-2023 Nordix Foundation. All rights reserved.
+#  Copyright (C) 2024 OpenInfra Foundation Europe. All rights reserved.
 #  ========================================================================
 #  Licensed under the Apache License, Version 2.0 (the "License");
 #  you may not use this file except in compliance with the License.

diff --git a/docs/api-docs.rst b/docs/api-docs.rst
new file mode 100644 (file)
index 0000000..7c74fff
--- /dev/null
+++ b/docs/api-docs.rst
@@ -0,0 +1,29 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. Copyright (C) 2024 OpenInfra Foundation Europe
+
+.. _api_docs:
+
+========
+API Docs
+========
+
+To view the Open API specs common to Service Manager and CAPIF, please see the following.
+
+.. raw:: html
+
+    <ul>
+    <li><a href="./Provider_Management.html">Provider Management</a></li>
+    <li><a href="./Publish_Service.html">Publish Service</a></li>
+    <li><a href="./Invoker_Management.html">Invoker Management</a></li>
+    <li><a href="./Discover_Service.html">Discover Service</a></li>
+    </ul>
+
+To view the Open API specs supported by CAPIF only, please see below.
+
+.. raw:: html
+
+    <ul>
+    <li><a href="./Events.html">Events</a></li>
+    <li><a href="./Security.html">Security</a></li>
+    </ul>

diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst
index b83b074..c89f019 100644 (file)
--- a/docs/developer-guide.rst
+++ b/docs/developer-guide.rst
@@ -6,24 +6,6 @@
 Developer Guide
 ===============
 
-This document provides a quick start for developers of the Non-RT RIC Service Management & Exposure. Additional developer guides are available on the `O-RAN SC NONRTRIC Developer wiki <https://wiki.o-ran-sc.org/display/RICNR/Release+F>`_.
+This document provides a quick start for developers of the Non-RT RIC Service Management & Exposure. Additional developer guides are available on the `O-RAN SC NONRTRIC Developer wiki <https://wiki.o-ran-sc.org/display/RICNR/Release+J>`_.
 
-To build and run the Service Manager implementation, see the README.md file in the "servicemanager" folder. To build and run the CAPIF Core implementation, see the README.md file in the "capifcore" folder. To view the Open API specs common to Service Manager and CAPIF, please see the following.
-
-.. raw:: html
-
-    <ul>
-    <li><a href="./Provider_Management.html">Provider Management</a></li>
-    <li><a href="./Publish_Service.html">Publish Service</a></li>
-    <li><a href="./Invoker_Management.html">Invoker Management</a></li>
-    <li><a href="./Discover_Service.html">Discover Service</a></li>
-    </ul>
-
-To view the Open API specs supported by CAPIF only, please see below.
-
-.. raw:: html
-
-    <ul>
-    <li><a href="./Events.html">Events</a></li>
-    <li><a href="./Security.html">Security</a></li>
-    </ul>
+To build and run the Service Manager implementation, see the README.md file in the "servicemanager" folder. To build and run the CAPIF Core implementation, see the README.md file in the "capifcore" folder.

diff --git a/docs/index.rst b/docs/index.rst
index 1a586d3..9bd14e1 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,6 +1,7 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 .. SPDX-License-Identifier: CC-BY-4.0
 .. Copyright (C) 2022-2023 Nordix
+.. Copyright (C) 2024 OpenInfra Foundation Europe
 
 Non-RT RIC Service Management and Exposure (SME)
 ================================================
@@ -12,3 +13,4 @@ Non-RT RIC Service Management and Exposure (SME)
    ./overview.rst
    ./developer-guide.rst
    ./release-notes.rst
+   ./api-docs.rst

diff --git a/docs/release-notes.rst b/docs/release-notes.rst
index f620893..e4a93f9 100644 (file)
--- a/docs/release-notes.rst
+++ b/docs/release-notes.rst
@@ -4,7 +4,7 @@
 .. Copyright (C) 2023-2024 OpenInfra Foundation Europe. All rights reserved.
 
 =============
-Release-Notes
+Release Notes
 =============