From ebad74013a00c7727f114ef90049e4a741cbdd07 Mon Sep 17 00:00:00 2001 From: subhash kumar singh Date: Thu, 26 Aug 2021 23:37:08 +0530 Subject: [PATCH] Add required file for the documentation Add required file for the documentation and correction. Change-Id: If62fa287c3471561093730371c11a3629b6856f9 Signed-off-by: subhash kumar singh --- .gitignore | 3 +++ .readthedocs.yaml | 16 ++++++++++++++++ docs/index.rst | 1 + docs/installation-guide.rst | 18 ++++-------------- docs/onboard-and-deploy.rst | 7 +++++-- tox.ini | 38 ++++++++++++++++++++++++++++++++++++++ 6 files changed, 67 insertions(+), 16 deletions(-) create mode 100644 .gitignore create mode 100644 .readthedocs.yaml create mode 100644 tox.ini diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..f6c9999 --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +# documentation +.tox +docs/_build/ \ No newline at end of file diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..8df5ada --- /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 \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index b181d12..c9ed140 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -14,6 +14,7 @@ Welcome to O-RAN SC HW-go Documentation release-notes.rst installation-guide.rst user-guide.rst + onboard-and-deploy.rst * :ref:`genindex` * :ref:`modindex` diff --git a/docs/installation-guide.rst b/docs/installation-guide.rst index ce5f0cb..967f983 100644 --- a/docs/installation-guide.rst +++ b/docs/installation-guide.rst @@ -15,16 +15,6 @@ Abstract This document describes how to install the reference HW-go xAPP. -Version history - -+--------------------+--------------------+--------------------+--------------------+ -| **Date** | **Ver.** | **Author** | **Comment** | -| | | | | -+--------------------+--------------------+--------------------+--------------------+ -| - |- |Rahul Banerji | - | -| | | | | -+--------------------+--------------------+--------------------+--------------------+ - Introduction ------------ @@ -37,7 +27,7 @@ Preface ------- 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. @@ -51,7 +41,7 @@ the Docker environment must be present in the system. 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 ./* . @@ -62,9 +52,9 @@ Deployment End to end deployment of `hw-go` can be referred at : - :ref: `Deployment Guide`. + :ref:`Deployment Guide`. -Testing +Testing -------- Unit tests TBD diff --git a/docs/onboard-and-deploy.rst b/docs/onboard-and-deploy.rst index bf12412..ca69274 100644 --- a/docs/onboard-and-deploy.rst +++ b/docs/onboard-and-deploy.rst @@ -7,6 +7,9 @@ Onboarding and Deployment of Hw-go xApp ======================================= +.. contents:: + :depth: 3 + :local: Onboarding of hw-go using dms_cli tool -------------------------------------- @@ -14,7 +17,7 @@ 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 `_ repository from gerrit. .. code-block:: bash @@ -39,7 +42,7 @@ First checkout the [hw-go] (https://gerrit.o-ran-sc.org/r/admin/repos/ric-app/hw └── 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 `_ to configure `dms_cli`. Once `dms_cli` is availabe we can proceed to onboarding procedure. diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000..9814213 --- /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 \ No newline at end of file -- 2.16.6