Configure Repo for Documentation
Change-Id: I11f75dc881965b01d44a3a7a7a86ad3d645fb8b9
Signed-off-by: nm755n <nm755n@intl.att.com>
diff --git a/.gitignore b/.gitignore
index ec1949e..53691a3 100644
--- a/.gitignore
+++ b/.gitignore
@@ -8,4 +8,6 @@
__pycache__/
*.html
*.log
-
+# documentation
+.tox
+docs/_build/
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
new file mode 100644
index 0000000..3797dc8
--- /dev/null
+++ b/.readthedocs.yaml
@@ -0,0 +1,20 @@
+---
+# .readthedocs.yml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+# Required
+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 100755
index 0000000..c3b6ce5
--- /dev/null
+++ b/docs/_static/logo.png
Binary files differ
diff --git a/docs/api-docs.rst b/docs/api-docs.rst
deleted file mode 100644
index 58c3b0c..0000000
--- a/docs/api-docs.rst
+++ /dev/null
@@ -1,35 +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
-============
-
-API document can be found in \Swagger\E2Manager_API.yaml
-
-API Introduction
----------------
-.. Please add what API a component have exposed.
-
-API Functions
----------------
-.. Please states the API functions.
-
diff --git a/docs/conf.py b/docs/conf.py
new file mode 100644
index 0000000..e06c3ac
--- /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 100644
index 0000000..80647a9
--- /dev/null
+++ b/docs/conf.yaml
@@ -0,0 +1,3 @@
+---
+project_cfg: oran
+project: ric-plt/e2mgr
diff --git a/docs/developer-guides.rst b/docs/developer-guides.rst
deleted file mode 100644
index 0a3c1c4..0000000
--- a/docs/developer-guides.rst
+++ /dev/null
@@ -1,49 +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:
-
-Developer-Guides
-==============
-
-
-.. note:
-.. * This section is used to describe what a contributor needs to know in order to work on the componenta
-
-.. * this should be very technical, aimed at people who want to help develop the components
-
-.. * this should be how the component does what it does, not a requirements document of what the component should do
-
-.. * this should contain what language(s) and frameworks are used, with versions
-
-.. * this should contain how to obtain the code, where to look at work items (Jira tickets), how to get started developing
-
-.. * This note must be removed after content has been added.
-
-
-Processes
----------
-
-
-
-Actions
--------
-
diff --git a/docs/favicon.ico b/docs/favicon.ico
new file mode 100755
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 100755
index 0000000..a9046c8
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,18 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. SPDX-License-Identifier: CC-BY-4.0
+
+
+Welcome to O-RAN SC ric-plt/e2mgr Documentation
+===============================================
+
+.. toctree::
+ :maxdepth: 2
+ :caption: Contents:
+
+ 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
index 535bb7b..0000000
--- a/docs/installation-guides.rst
+++ /dev/null
@@ -1,129 +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:
-
-========
-Abstract
-========
-
-This document describes how to install <Component>, it's dependencies and required system resources.
-
-.. contents::
- :depth: 3
- :local:
-
-Version history
----------------------
-
-+--------------------+--------------------+--------------------+--------------------+
-| **Date** | **Ver.** | **Author** | **Comment** |
-| | | | |
-+--------------------+--------------------+--------------------+--------------------+
-| 20XX-XX-XX | 0.1.0 | | First draft |
-| | | | |
-+--------------------+--------------------+--------------------+--------------------+
-| | 0.1.1 | | |
-| | | | |
-+--------------------+--------------------+--------------------+--------------------+
-| | 1.0 | | |
-| | | | |
-| | | | |
-+--------------------+--------------------+--------------------+--------------------+
-
-
-Introduction
-============
-.. <INTRODUCTION TO THE SCOPE AND INTENTION OF THIS DOCUMENT AS WELL AS TO THE SYSTEM TO BE INSTALLED>
-
-.<EXAMPLE>:
-
-This document describes the supported software and hardware configurations for the reference component as well as providing guidelines on how to install and configure such reference system.
-
-The audience of this document is assumed to have good knowledge in RAN network nd Linux system.
-
-
-Preface
-=======
-.. <DESCRIBE NEEDED PREREQUISITES, PLANNING, ETC.>
-
-<EXAMPLE>:
-
-Before starting the installation of <project name>, some planning must preceed.
-
-.. note:any preperation you need before setting up sotfware and hardware
-
-
-Hardware requirements
-=====================
-.. <PROVIDE A LIST OF MINIMUM HARDWARE REQUIREMENTS NEEDED FOR THE INSTALL>
-
-<EXAMPLE>:
-
-Following minimum hardware requirements must be met for installation of <project name>:
-
-+--------------------+----------------------------------------------------+
-| **HW Aspect** | **Requirement** |
-| | |
-+--------------------+----------------------------------------------------+
-| **# of servers** | |
-+--------------------+----------------------------------------------------+
-| **CPU** | |
-| | |
-+--------------------+----------------------------------------------------+
-| **RAM** | |
-| | |
-+--------------------+----------------------------------------------------+
-| **Disk** | |
-| | |
-+--------------------+----------------------------------------------------+
-| **NICs** | |
-| | |
-| | |
-| | |
-| | |
-| | |
-+--------------------+----------------------------------------------------+
-
-
-
-
-
-Software installation and deployment
-==========================================
-.. <DESCRIBE THE FULL PROCEDURES FOR THE INSTALLATION OF THE O-RAN COMPONENT INSTALLATION AND DEPLOYMENT>
-
-<EXAMPLE>:
-
-This section describes the installation of the <project name> installation on the reference hardware.
-
-
-
-References
-==========
-.. <PROVIDE NEEDED/USEFUL REFERENCES>
-
-<EXAMPLES>:
-
-OpenStack
-^^^^^^^^^^^
-
-
diff --git a/docs/overview.rst b/docs/overview.rst
new file mode 100755
index 0000000..8772b2c
--- /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-BY-4.0
+
+
+..please write your project overview
+..please delete this content after editing
+
+
+ric-plt/e2mgr Overview
+======================
diff --git a/docs/release-notes.rst b/docs/release-notes.rst
index f14612e..aa8ee19 100644
--- a/docs/release-notes.rst
+++ b/docs/release-notes.rst
@@ -19,12 +19,12 @@
E2 Manager Release Notes
-============================================================================================
+========================
The following is a list of release highlights for E2 Manager:
2019 October 31; version 2.0.7
---------------------------------------------------------------------------------------------
+------------------------------
The following flows are supported:
- ENDC Setup
- X2 Setup
@@ -90,7 +90,7 @@
Feature additions
-~~~~~~~~~~~~~~~~~~~~~~~
+-----------------
<STATE ADDED FEATURES BY REFERENCE TO JIRA>
<EXAMPLE>:
@@ -111,7 +111,7 @@
+--------------------------------------+--------------------------------------+
Bug corrections
-~~~~~~~~~~~~~~~~~~~~~
+---------------
**JIRA TICKETS:**
@@ -129,17 +129,17 @@
+--------------------------------------+--------------------------------------+
Deliverables
-----------------
+------------
Software deliverables
-^^^^^^^^^^^^^^^^^^^^^^^
+---------------------
<STATE WHAT SOFTWARE DELIVERABLES THAT ARE RELATED TO THIS VERSION, AND WHERE THOSE CAN BE RETRIEVED>
<EXAMPLE>:
Documentation deliverables
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+--------------------------
<STATE WHAT DOCUMENTATION DELIVERABLES THAT ARE RELATED TO THIS VERSION, AND WHERE THOSE CAN BE RETRIEVED>
@@ -150,13 +150,13 @@
=========================================
System Limitations
-^^^^^^^^^^^^^^^^^^^^
+------------------
<STATE ALL RELEVANT SYSTEM LIMITATIONS, IF THERE IS ANY>
Known issues
-^^^^^^^^^^^^^^^
+------------
<STATE ALL KNOWN ISSUES WITH JIRA REFERENCE>
<EXAMPLE>:
@@ -177,7 +177,7 @@
+--------------------------------------+--------------------------------------+
Workarounds
-^^^^^^^^^^^^^^^^^
+-----------
<STATE ALL KNOWN WORKAROUNDS TO THE ISSUES STATED ABOVE, IF THERE IS ANY>
diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt
new file mode 100644
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
index 0000000..db50ddf
--- /dev/null
+++ b/tox.ini
@@ -0,0 +1,32 @@
+[tox]
+minversion = 2.0
+envlist =
+ docs,
+ docs-linkcheck,
+
+skipsdist = true
+
+[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
