Add required file for the documentation and correction.
Change-Id: If62fa287c3471561093730371c11a3629b6856f9
Signed-off-by: subhash kumar singh <subh.singh@samsung.com>
--- /dev/null
+# documentation
+.tox
+docs/_build/
\ No newline at end of file
--- /dev/null
+---
+version: 2
+
+formats:
+ - htmlzip
+
+build:
+ image: latest
+
+python:
+ version: 3.7
+ install:
+ - requirements: docs/requirements-docs.txt
+
+sphinx:
+ configuration: docs/conf.py
\ No newline at end of file
release-notes.rst
installation-guide.rst
user-guide.rst
+ onboard-and-deploy.rst
* :ref:`genindex`
* :ref:`modindex`
This document describes how to install the reference HW-go xAPP.
-Version history
-
-+--------------------+--------------------+--------------------+--------------------+
-| **Date** | **Ver.** | **Author** | **Comment** |
-| | | | |
-+--------------------+--------------------+--------------------+--------------------+
-| - |- |Rahul Banerji | - |
-| | | | |
-+--------------------+--------------------+--------------------+--------------------+
-
Introduction
------------
-------
This xAPP can be run directly as a Linux binary, as a docker image, or in a pod in a Kubernetes environment. The first
two can be used for dev testing. The last option is how an xAPP is deployed in the RAN Intelligent Controller environment.
-This document covers all three methods.
+This document covers all three methods.
Build Process
~~~~~~~~~~~~~
The HW-go xAPP can be either tested as a Linux binary or as a docker image.
- 1. **Linux binary**:
+ 1. **Linux binary**:
TBD
2. **Docker Image**: From the root of the repository, run *docker --no-cache build -t <image-name> ./* .
End to end deployment of `hw-go` can be referred at :
- :ref: `Deployment Guide`.
+ :ref:`Deployment Guide`.
-Testing
+Testing
--------
Unit tests TBD
Onboarding and Deployment of Hw-go xApp
=======================================
+.. contents::
+ :depth: 3
+ :local:
Onboarding of hw-go using dms_cli tool
--------------------------------------
`dms_cli` offers rich set of command line utility to onboard *hw-go* xapp
to `chartmuseme`.
-First checkout the [hw-go] (https://gerrit.o-ran-sc.org/r/admin/repos/ric-app/hw-go) repository from gerrit.
+First checkout the `hw-go <https://gerrit.o-ran-sc.org/r/admin/repos/ric-app/hw-go>`_ repository from gerrit.
.. code-block:: bash
└── hwApp.go
-For onboarding `hw-go` make sure that `dms_cli` and helm3 is installed. One can follow [documentation](https://docs.o-ran-sc.org/projects/o-ran-sc-it-dep/en/latest/installation-guides.html#ric-applications) to
+For onboarding `hw-go` make sure that `dms_cli` and helm3 is installed. One can follow `documentation <https://docs.o-ran-sc.org/projects/o-ran-sc-it-dep/en/latest/installation-guides.html#ric-applications>`_ to
configure `dms_cli`.
Once `dms_cli` is availabe we can proceed to onboarding procedure.
--- /dev/null
+# 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
\ No newline at end of file