Fixes to RST documentation as per guidelines

Change-Id: I92cbb0f37a0c2dca9163294012d16e1af97f049d
Signed-off-by: czichy <thoralf.czichy@nokia.com>

diff --git a/docs/api-docs.rst b/docs/api-docs.rst
deleted file mode 100644 (file)
index 087b592..0000000
--- a/docs/api-docs.rst
+++ /dev/null
@@ -1,28 +0,0 @@
-.. 
-..  Copyright (c) 2019 AT&T Intellectual Property.
-..  Copyright (c) 2019 Nokia.
-..
-..  Licensed under the Creative Commons Attribution 4.0 International
-..  Public License (the "License"); you may not use this file except
-..  in compliance with the License. You may obtain a copy of the License at
-..
-..    https://creativecommons.org/licenses/by/4.0/
-..
-..  Unless required by applicable law or agreed to in writing, documentation
-..  distributed under the License is distributed on an "AS IS" BASIS,
-..  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-..
-..  See the License for the specific language governing permissions and
-..  limitations under the License.
-..
-
-.. contents::
-   :depth: 3
-   :local:
-
-API-docs
-============
-
-The API (ASN.1 definitions) ae defined in the E2AP document and a copy of the ASN.1 is in the ASN.1 file of 
-this repository. This is the version of the E2 that the near-RT RIC platform is implemented against.
-

diff --git a/docs/index.rst b/docs/index.rst
index 40c035d..6774d92 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -16,19 +16,18 @@
 ..  limitations under the License.
 ..
 
-ASN1 documents
-==============
+Welcome to O-RAN SC ASN.1 documents Documentation
+=================================================
 
 
 .. toctree::
-   :maxdepth: 1
+   :maxdepth: 2
    :caption: Contents:
 
-   api-docs.rst
-   developer-guides.rst
-   installation-guides.rst
+   overview.rst
    release-notes.rst
 
+* :ref:`genindex`
+* :ref:`modindex`
 * :ref:`search`
 
-

diff --git a/docs/installation-guides.rst b/docs/installation-guides.rst
deleted file mode 100644 (file)
index f69a90e..0000000
--- a/docs/installation-guides.rst
+++ /dev/null
@@ -1,21 +0,0 @@
-.. 
-..  Copyright (c) 2019 AT&T Intellectual Property.
-..  Copyright (c) 2019 Nokia.
-..
-..  Licensed under the Creative Commons Attribution 4.0 International
-..  Public License (the "License"); you may not use this file except
-..  in compliance with the License. You may obtain a copy of the License at
-..
-..    https://creativecommons.org/licenses/by/4.0/
-..
-..  Unless required by applicable law or agreed to in writing, documentation
-..  distributed under the License is distributed on an "AS IS" BASIS,
-..  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-..
-..  See the License for the specific language governing permissions and
-..  limitations under the License.
-..
-
-Since this component/repository only contains ASN.1 definitions and relatd documentation there is no installation
-guide for it. The api-docs contains more information.
-

diff --git a/docs/developer-guides.rst b/docs/overview.rst
similarity index 79%
rename from docs/developer-guides.rst
rename to docs/overview.rst
index 3841ea6..6a5476a 100644 (file)
--- a/docs/developer-guides.rst
+++ b/docs/overview.rst
@@ -16,12 +16,7 @@
 ..  limitations under the License.
 ..
 
-.. contents::
-   :depth: 3
-   :local:
-
-Developer-Guides
-================
-
-This component only provides what is listed in API docs.
+Overview
+========
 
+The latest release of the near-RT RIC component "asn1-documents" which contains a description of the E2 used in the near-RT RIC implementation under O-RAN-SC.

diff --git a/docs/release-notes.rst b/docs/release-notes.rst
index 1719996..01cdc4e 100644 (file)
--- a/docs/release-notes.rst
+++ b/docs/release-notes.rst
@@ -16,15 +16,17 @@
 ..  limitations under the License.
 ..
 
+Release Notes
+=============
 
 This document provides the release notes for the latest release of the near-RT RIC component "asn1-documents".
 
 .. contents::
    :depth: 3
-      :local:
+   :local:
 
-Version 1.0.0, October 2019
----------------------------
+[1.0.0] - 2019-10
+-----------------
 * initial version 
 * E2AP document version (PDF, DOC) used in near-RT RIC project
 * ASN.1 copy of the ASN.1 definitions in DOC/PDF document