Add docs for master

Change-Id: I1bf17b08fd817bda91e723c780f9e9ed46689c7b
Signed-off-by: Mohamed Abukar <abukar.mohamed@nokia.com>

diff --git a/.gitignore b/.gitignore
index 860c008..9c14461 100644 (file)
--- a/.gitignore
+++ b/.gitignore
@@ -1,2 +1,3 @@
-cache
-
+# documentation
+.tox
+docs/_build/

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
new file mode 100644 (file)
index 0000000..095222a
--- /dev/null
+++ b/.readthedocs.yaml
@@ -0,0 +1,16 @@
+---
+version: 2
+
+formats:
+  - htmlzip
+
+build:
+  image: latest
+
+python:
+  version: 3.7
+  install:
+    - requirements: docs/requirements-docs.txt
+
+sphinx:
+  configuration: docs/conf.py

diff --git a/README.md b/README.md
index 71e03b4..e5d6f0f 100755 (executable)
--- a/README.md
+++ b/README.md
@@ -83,4 +83,5 @@ Congratulations! You've just built your first **xapp** application.
 ## Community
 
 ## License
-This project is licensed under the Apache License 2.0 - see the [LICENSE.md](LICENSE.md) file for details
\ No newline at end of file
+This project is licensed under the Apache License 2.0 - see the [LICENSE.md](LICENSE.md) file for details
+

diff --git a/docs/_static/logo.png b/docs/_static/logo.png
new file mode 100644 (file)
index 0000000..c3b6ce5
Binary files /dev/null and b/docs/_static/logo.png differ

diff --git a/docs/conf.py b/docs/conf.py
new file mode 100755 (executable)
index 0000000..922e22f
--- /dev/null
+++ b/docs/conf.py
@@ -0,0 +1,6 @@
+from docs_conf.conf import *
+linkcheck_ignore = [
+    'http://localhost.*',
+    'http://127.0.0.1.*',
+    'https://gerrit.o-ran-sc.org.*'
+]

diff --git a/docs/conf.yaml b/docs/conf.yaml
new file mode 100755 (executable)
index 0000000..46531e5
--- /dev/null
+++ b/docs/conf.yaml
@@ -0,0 +1,3 @@
+---
+project_cfg: oran
+project: xapp-frame

diff --git a/docs/favicon.ico b/docs/favicon.ico
new file mode 100644 (file)
index 0000000..00b0fd0
Binary files /dev/null and b/docs/favicon.ico differ

diff --git a/docs/index.rst b/docs/index.rst
new file mode 100755 (executable)
index 0000000..a576c5c
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,45 @@
+..\r
+.. Copyright (c) 2019 AT&T Intellectual Property.\r
+..\r
+.. Copyright (c) 2019 Nokia.\r
+..\r
+..\r
+.. Licensed under the Creative Commons Attribution 4.0 International\r
+..\r
+.. Public License (the "License"); you may not use this file except\r
+..\r
+.. in compliance with the License. You may obtain a copy of the License at\r
+..\r
+..\r
+..     https://creativecommons.org/licenses/by/4.0/\r
+..\r
+..\r
+.. Unless required by applicable law or agreed to in writing, documentation\r
+..\r
+.. distributed under the License is distributed on an "AS IS" BASIS,\r
+..\r
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
+..\r
+.. See the License for the specific language governing permissions and\r
+..\r
+.. limitations under the License.\r
+..\r
+.. This source code is part of the near-RT RIC (RAN Intelligent Controller) platform project (RICP).\r
+..\r
+\r
+\r
+Welcome to O-RAN SC xapp-frame Documentation\r
+============================================\r
+\r
+.. toctree::\r
+   :maxdepth: 2\r
+   :caption: Contents:\r
+\r
+   overview.rst\r
+   release-notes.rst\r
+\r
+\r
+\r
+* :ref:`genindex`\r
+* :ref:`modindex`\r
+* :ref:`search`
\ No newline at end of file

diff --git a/docs/overview.rst b/docs/overview.rst
new file mode 100755 (executable)
index 0000000..0b5d0f4
--- /dev/null
+++ b/docs/overview.rst
@@ -0,0 +1,33 @@
+..\r
+.. Copyright (c) 2019 AT&T Intellectual Property.\r
+..\r
+.. Copyright (c) 2019 Nokia.\r
+..\r
+..\r
+.. Licensed under the Creative Commons Attribution 4.0 International\r
+..\r
+.. Public License (the "License"); you may not use this file except\r
+..\r
+.. in compliance with the License. You may obtain a copy of the License at\r
+..\r
+..\r
+..     https://creativecommons.org/licenses/by/4.0/\r
+..\r
+..\r
+.. Unless required by applicable law or agreed to in writing, documentation\r
+..\r
+.. distributed under the License is distributed on an "AS IS" BASIS,\r
+..\r
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
+..\r
+.. See the License for the specific language governing permissions and\r
+..\r
+.. limitations under the License.\r
+..\r
+.. This source code is part of the near-RT RIC (RAN Intelligent Controller) platform project (RICP).\r
+..\r
+\r
+xapp.frame Overview\r
+===================\r
+\r
+xapp-frame is a simple framework for rapid development of RIC xapps, and supports various services essential for RIC xapps such as RESTful APIs, RMR (RIC Message Routing), database backend services and watching and populating config-map changes in K8S environment
\ No newline at end of file

diff --git a/docs/release-notes.rst b/docs/release-notes.rst
new file mode 100755 (executable)
index 0000000..2c8651f
--- /dev/null
+++ b/docs/release-notes.rst
@@ -0,0 +1,122 @@
+   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.
+
+   This source code is part of the near-RT RIC (RAN Intelligent Controller) platform project (RICP).
+
+Release-Notes
+=============
+
+
+This document provides the release notes for v0.0.22 of xapp-frame.
+
+.. contents::
+   :depth: 3
+   :local:
+
+
+Version history
+---------------
+
++--------------------+--------------------+--------------------+--------------------+
+| **Date**           | **Ver.**           | **Author**         | **Comment**        |
+|                    |                    |                    |                    |
++--------------------+--------------------+--------------------+--------------------+
+| 2019-11-21         | 0.0.22             | Abukar Mohamed     | Latest version     |
+|                    |                    |                    |                    |
++--------------------+--------------------+--------------------+--------------------+
+
+
+Summary
+-------
+
+This is the first release of this package.
+
+
+
+Release Data
+------------
+
++--------------------------------------+--------------------------------------+
+| **Project**                          | xApp-frame                           |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Repo/commit-ID**                   | ric-plt/xapp-frame                   |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Release designation**              | Amber                                |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Release date**                     | 2019-11-21                           |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Purpose of the delivery**          | First Release                        |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+
+Feature Additions
+^^^^^^^^^^^^^^^^^
+
+Bug Corrections
+^^^^^^^^^^^^^^^
+
+Deliverables
+^^^^^^^^^^^^
+
+Software Deliverables
++++++++++++++++++++++
+
+This version provides Golang package for xapp-frame
+It can be retrieved from https://gerrit.o-ran-sc.org/r/ric-plt/xapp-frame.
+
+
+
+Documentation Deliverables
+++++++++++++++++++++++++++
+
+
+
+
+Known Limitations, Issues and Workarounds
+-----------------------------------------
+
+System Limitations
+^^^^^^^^^^^^^^^^^^
+
+
+
+Known Issues
+^^^^^^^^^^^^
+
+Workarounds
+^^^^^^^^^^^
+
+
+
+
+
+References
+----------
+
+

diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt
new file mode 100644 (file)
index 0000000..09a0c1c
--- /dev/null
+++ b/docs/requirements-docs.txt
@@ -0,0 +1,5 @@
+sphinx
+sphinx-rtd-theme
+sphinxcontrib-httpdomain
+recommonmark
+lfdocs-conf

diff --git a/tox.ini b/tox.ini
new file mode 100644 (file)
index 0000000..ac38348
--- /dev/null
+++ b/tox.ini
@@ -0,0 +1,38 @@
+# documentation only
+[tox]
+minversion = 2.0
+envlist =
+    docs,
+    docs-linkcheck,
+skipsdist = true
+
+[testenv:docs]
+passenv =
+   http_proxy
+   https_proxy
+
+basepython = python3
+deps =
+    sphinx
+    sphinx-rtd-theme
+    sphinxcontrib-httpdomain
+    recommonmark
+    lfdocs-conf
+
+commands =
+    sphinx-build -W -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
+    echo "Generated docs available in {toxinidir}/docs/_build/html"
+whitelist_externals = echo
+
+[testenv:docs-linkcheck]
+passenv =
+   http_proxy
+   https_proxy
+
+basepython = python3
+deps = sphinx
+       sphinx-rtd-theme
+       sphinxcontrib-httpdomain
+       recommonmark
+       lfdocs-conf
+commands = sphinx-build -W -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck