Add ReadTheDocs configuration/site in repo root directory
Issue-ID: NONRTRIC-864
Change-Id: I648b265d07b673eb0a186e78132169c1c541e9e7
Signed-off-by: JohnKeeney <john.keeney@est.tech>
diff --git a/docs/conf.py b/docs/conf.py
new file mode 100644
index 0000000..7639988
--- /dev/null
+++ b/docs/conf.py
@@ -0,0 +1,34 @@
+from docs_conf import *
+
+branch = 'latest'
+selfurl = 'https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric-plt-ranpm/en/%s' % branch
+
+linkcheck_ignore = [
+ 'http://localhost.*',
+ 'http://127.0.0.1.*',
+ 'https://gerrit.o-ran-sc.org.*'
+]
+
+#branch configuration
+
+
+linkcheck_ignore = [
+ 'http://localhost.*',
+ 'http://127.0.0.1.*',
+ 'https://gerrit.o-ran-sc.org.*',
+]
+
+extensions = [
+ 'sphinx.ext.intersphinx',
+ 'sphinx.ext.autosectionlabel',
+]
+
+#intershpinx mapping with other projects
+#intersphinx_mapping = {}
+## Note there is a circular dependency here - sub-project pages must exist before they can be checked
+#intersphinx_mapping['influxlogger'] = ('%s/influxlogger' % selfurl, None)
+#intersphinx_mapping['datafilecollector'] = ('%s/datafilecollector' % selfurl, None)
+#intersphinx_mapping['pmproducer'] = ('%s/pmproducer' % selfurl, None)
+
+
+intersphinx_disabled_reftypes = ["*"]
diff --git a/docs/conf.yaml b/docs/conf.yaml
new file mode 100644
index 0000000..1396954
--- /dev/null
+++ b/docs/conf.yaml
@@ -0,0 +1,6 @@
+---
+project_cfg: oran
+project: nonrtric-plt-ranpm
+
+# Change this to ReleaseBranchName to modify the header
+default-version: latest
diff --git a/docs/favicon.ico b/docs/favicon.ico
new file mode 100644
index 0000000..00b0fd0
--- /dev/null
+++ b/docs/favicon.ico
Binary files differ
diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644
index 0000000..8e8fd5b
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,13 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. SPDX-License-Identifier: CC-BY-4.0
+.. Copyright (C) 2021 Nordix
+
+Non-RT RIC RAN PM Usecase / Functions
+===========================================
+
+.. toctree::
+ :maxdepth: 2
+ :caption: Contents:
+
+ ./overview.rst
+ ./release-notes.rst
diff --git a/docs/overview.rst b/docs/overview.rst
new file mode 100644
index 0000000..91310db
--- /dev/null
+++ b/docs/overview.rst
@@ -0,0 +1,14 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. SPDX-License-Identifier: CC-BY-4.0
+.. Copyright (C) 2023 Nordix
+
+Non-RT RIC RAN PM Usecase/Functions
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Perent repo Non-RT RIC RAN PM Usecase/Functions
+
+**************
+Implementation
+**************
+
+Implemented as multiple functions in sub directories
diff --git a/docs/release-notes.rst b/docs/release-notes.rst
new file mode 100644
index 0000000..cb0c8cd
--- /dev/null
+++ b/docs/release-notes.rst
@@ -0,0 +1,45 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. Copyright (C) 2023 Nordix
+
+=============
+Release-Notes
+=============
+
+
+This document provides the release notes for the release of the Non-RT RIC RAN PM Usecase/Functions.
+
+
+Version history RAN PM Usecase/Functions
+========================================
+
++------------+----------+------------------+--------------------+
+| **Date** | **Ver.** | **Author** | **Comment** |
+| | | | |
++------------+----------+------------------+--------------------+
+| 2023-04-21 | 0.0.0 | John Keeney | Started Docs. |
+| | | | Remove this row |
++------------+----------+------------------+--------------------+
+
+
+Release Data
+============
+
+H
+-
++-----------------------------+---------------------------------------------------+
+| **Project** | Non-RT RIC RAN PM |
+| | |
++-----------------------------+---------------------------------------------------+
+| **Repo/commit-ID** | |
+| | |
++-----------------------------+---------------------------------------------------+
+| **Release designation** | H |
+| | |
++-----------------------------+---------------------------------------------------+
+| **Release date** | 2023-06-xx |
+| | |
++-----------------------------+---------------------------------------------------+
+| **Purpose of the delivery** | First release of RAN PM Usecase/Functions |
+| | |
++-----------------------------+---------------------------------------------------+
diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt
new file mode 100644
index 0000000..ec7ae3e
--- /dev/null
+++ b/docs/requirements-docs.txt
@@ -0,0 +1,13 @@
+tox
+Sphinx
+doc8
+docutils
+setuptools
+six
+sphinx_rtd_theme
+sphinxcontrib-needs
+sphinxcontrib-swaggerdoc
+sphinx_bootstrap_theme
+sphinxcontrib-redoc
+lfdocs-conf
+sphinx-multiproject