Documentation files added

Issue-Id: AIMLFW-12

Signed-off-by: josephthaliath <jo.thaliath@samsung.com>
Change-Id: I10434c32bb4287ce83feaf683799d26a4621a6a2
Signed-off-by: josephthaliath <jo.thaliath@samsung.com>

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/docs/_static/logo.png b/docs/_static/logo.png
new file mode 100644 (file)
index 0000000..3803e04
Binary files /dev/null and b/docs/_static/logo.png differ

diff --git a/docs/conf.py b/docs/conf.py
new file mode 100644 (file)
index 0000000..f87d976
--- /dev/null
+++ b/docs/conf.py
@@ -0,0 +1,35 @@
+# ==================================================================================
+#
+#       Copyright (c) 2022 Samsung Electronics Co., Ltd. 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.
+#   You may obtain a copy of the License at
+#
+#          http://www.apache.org/licenses/LICENSE-2.0
+#
+#   Unless required by applicable law or agreed to in writing, software
+#   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.
+#
+# ==================================================================================
+
+from docs_conf.conf import *
+
+linkcheck_ignore = [
+    'http://localhost.*',
+    'http://127.0.0.1.*',
+    'https://gerrit.o-ran-sc.org.*'
+]
+
+#branch configuration
+branch = 'latest'
+
+#intershpinx mapping with other projects
+intersphinx_mapping = {}
+
+
+#AIMLFW deployment installation guide
+intersphinx_mapping['aimlfw-dep'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-aiml-fw-aimlfw-dep/en/%s' % branch, None)

diff --git a/docs/conf.yaml b/docs/conf.yaml
new file mode 100644 (file)
index 0000000..e0ea293
--- /dev/null
+++ b/docs/conf.yaml
@@ -0,0 +1,6 @@
+---
+project_cfg: oran
+project: aimlfw-kfadapter
+
+# Change this to ReleaseBranchName to modify the header
+version: latest

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 100644 (file)
index 0000000..7dd6b2f
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,20 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. SPDX-License-Identifier: CC-B
+
+.. Copyright (c) 2022 Samsung Electronics Co., Ltd. All Rights Reserved.
+
+Welcome to O-RAN SC AIMLFW Kubeflow adapter Documentation
+=========================================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   overview.rst
+   release-notes.rst
+   installation-guide.rst
+
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

diff --git a/docs/installation-guide.rst b/docs/installation-guide.rst
new file mode 100644 (file)
index 0000000..fc738e8
--- /dev/null
+++ b/docs/installation-guide.rst
@@ -0,0 +1,39 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+.. Copyright (c) 2022 Samsung Electronics Co., Ltd. All Rights Reserved.
+
+
+Installation Guide
+==================
+
+.. contents::
+   :depth: 3
+   :local:
+
+Abstract
+--------
+
+This document describes how to install AIMLFW, it's dependencies and required system resources.
+
+
+Version history
+
++--------------------+--------------------+--------------------+--------------------+
+| **Date**           | **Ver.**           | **Author**         | **Comment**        |
+|                    |                    |                    |                    |
++--------------------+--------------------+--------------------+--------------------+
+| 2022-11-30         | 1.0.0              | Joseph Thaliath    | G release          |
+|                    |                    |                    |                    |
++--------------------+--------------------+--------------------+--------------------+
+
+
+Introduction
+------------
+
+.. <INTRODUCTION TO THE SCOPE AND INTENTION OF THIS DOCUMENT AS WELL AS TO THE SYSTEM TO BE INSTALLED>
+
+
+Installation scripts are located in the aimlfw-dep repository and installation guide is mentioned in the following link
+
+* :doc:`AIMLFW Installation Guide <aimlfw-dep:index>`

diff --git a/docs/overview.rst b/docs/overview.rst
new file mode 100644 (file)
index 0000000..2205689
--- /dev/null
+++ b/docs/overview.rst
@@ -0,0 +1,10 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. SPDX-License-Identifier: CC-B
+
+.. Copyright (c) 2022 Samsung Electronics Co., Ltd. All Rights Reserved.
+
+
+Overview of AIMLFW Kubeflow adapter (aiml-fw/athp/tps/kubeflow-adapter)
+-----------------------------------------------------------------------
+
+This module is responsible for providing connectivity to Kubeflow for creating AI/ML training pipelines and executing AI/ML training jobs

diff --git a/docs/release-notes.rst b/docs/release-notes.rst
new file mode 100644 (file)
index 0000000..549e864
--- /dev/null
+++ b/docs/release-notes.rst
@@ -0,0 +1,53 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. SPDX-License-Identifier: CC-B
+
+.. Copyright (c) 2022 Samsung Electronics Co., Ltd. All Rights Reserved.
+
+
+Release-Notes
+-------------
+
+This document provides the release notes for the G release of AIMLFW Kubeflow adapter module
+
+.. contents::
+   :depth: 3
+   :local:
+
+Version history
+---------------
+
++--------------------+--------------------+--------------------+--------------------+
+| **Date**           | **Ver.**           | **Author**         | **Comment**        |
+|                    |                    |                    |                    |
++--------------------+--------------------+--------------------+--------------------+
+| 2022-12-08         | 1.0.0              | Joseph Thaliath    | G release          |
+|                    |                    |                    |                    |
++--------------------+--------------------+--------------------+--------------------+
+
+
+Summary
+-------
+
+The G release of AIMLFW Kubeflow adapter supports connectivity to Kubeflow for creating AI/ML training pipelines and executing AI/ML training jobs
+
+
+Release Data
+------------
+
++--------------------------------------+--------------------------------------+
+| **Project**                          | AIMLFW Kubeflow adapter              |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Repo/commit-ID**                   | aiml-fw/athp/tps/kubeflow-adapter    |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Release designation**              | G release                            |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Release date**                     | 2022-12-15                           |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Purpose of the delivery**          | AIMLFW Kubeflow adapter              |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+

diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt
new file mode 100644 (file)
index 0000000..7372123
--- /dev/null
+++ b/docs/requirements-docs.txt
@@ -0,0 +1,6 @@
+sphinx
+sphinx_rtd_theme>=1.0.0
+docutils<0.17
+sphinxcontrib-httpdomain
+recommonmark
+lfdocs-conf

diff --git a/tox.ini b/tox.ini
index 80b0637..f8f4980 100644 (file)
--- a/tox.ini
+++ b/tox.ini
@@ -17,7 +17,7 @@
 # ==================================================================================
 
 [tox]
-envlist = code
+envlist = code,docs,docs-linkcheck
 skipsdist = true
 
 # basic test and coverage job
@@ -43,4 +43,30 @@ commands =
   pip3 install {toxinidir}
 
   pytest --cov {toxinidir}/kfadapter --cov-report xml --cov-report term-missing --cov-report html --cov-fail-under=10 --junitxaml=/tmp/tests.xml
-  coverage xml -i
\ No newline at end of file
+  coverage xml -i
+
+# Docs
+
+[testenv:docs]
+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]
+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
+