Add docs build support

Change-Id: I5443fd513b7f9e05434dd1a3e41425172d9b9136
Signed-off-by: Roni Riska <roni.riska@nokia.com>

diff --git a/.gitignore b/.gitignore
new file mode 100644 (file)
index 0000000..4fade8d
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,26 @@
+# Copyright (c) 2019 AT&T Intellectual Property.
+# Copyright (c) 2018-2019 Nokia.
+#
+# 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.
+
+# Compiled python modules.
+*.pyc
+
+# Setuptools distribution folder.
+/dist/
+
+# Python egg metadata, regenerated from source files by setuptools.
+/*.egg-info
+.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/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 100644 (file)
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 100644 (file)
index 0000000..eb87731
--- /dev/null
+++ b/docs/conf.yaml
@@ -0,0 +1,3 @@
+---
+project_cfg: oran
+project: com-golog

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..e64330f
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,43 @@
+..\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
+\r
+\r
+Welcome to O-RAN SC vespamgr 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 100644 (file)
index 0000000..aaa7d48
--- /dev/null
+++ b/docs/overview.rst
@@ -0,0 +1,38 @@
+..\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
+\r
+\r
+vespamgr Overview\r
+=================\r
+\r
+The VESPA manager uses the VES Agent (https://github.com/nokia/ONAP-VESPA)\r
+to adapt near-RT RIC internal statistics' collection using Prometheus\r
+(xApps and platform containers) to ONAP's VES (VNF event streaming).\r
+\r
+The vesmgr container runs two processes: the VESPA manager and the VES Agent (i.s. VESPA).\r
+The VESPA manager starts and configures the VES Agent.\r
+The VES Agent is a service acting as a bridge between Prometheus and ONAP's VES Collector.
\ No newline at end of file

diff --git a/docs/release-notes.rst b/docs/release-notes.rst
new file mode 100644 (file)
index 0000000..a0abab0
--- /dev/null
+++ b/docs/release-notes.rst
@@ -0,0 +1,116 @@
+..\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
+\r
+\r
+Release-Notes\r
+=============\r
+\r
+\r
+This document provides the release notes for version 0.0.8 of vespamgr.\r
+\r
+.. contents::\r
+   :depth: 3\r
+   :local:\r
+\r
+\r
+Version history\r
+---------------\r
+\r
++--------------------+--------------------+--------------------+--------------------+\r
+| **Date**           | **Ver.**           | **Author**         | **Comment**        |\r
+|                    |                    |                    |                    |\r
++--------------------+--------------------+--------------------+--------------------+\r
+| 2019-11-13         | 0.0.8              | R Riska            | First version      |\r
+|                    |                    |                    |                    |\r
++--------------------+--------------------+--------------------+--------------------+\r
+\r
+\r
+Summary\r
+-------\r
+\r
+This is the first version of this component.\r
+\r
+\r
+\r
+\r
+Release Data\r
+------------\r
+\r
+This is the first version of this component.\r
+\r
+\r
+\r
+\r
+Feature Additions\r
+^^^^^^^^^^^^^^^^^\r
+\r
+Bug Corrections\r
+^^^^^^^^^^^^^^^\r
+\r
+\r
+Deliverables\r
+^^^^^^^^^^^^\r
+\r
+Software Deliverables\r
++++++++++++++++++++++\r
+\r
+The deliverable is a container running two processes:\r
+- VESPA manager\r
+- VES Agent, i.e. VESPA (https://github.com/nokia/ONAP-VESPA)\r
+\r
+\r
+\r
+\r
+Documentation Deliverables\r
+++++++++++++++++++++++++++\r
+\r
+\r
+\r
+\r
+\r
+Known Limitations, Issues and Workarounds\r
+-----------------------------------------\r
+\r
+System Limitations\r
+^^^^^^^^^^^^^^^^^^\r
+\r
+\r
+\r
+Known Issues\r
+^^^^^^^^^^^^\r
+\r
+Workarounds\r
+^^^^^^^^^^^\r
+\r
+\r
+\r
+\r
+\r
+References\r
+----------\r
+\r
+\r

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