From: nm755n Date: Wed, 20 Nov 2019 14:11:35 +0000 (+0000) Subject: Configure Repo for Documentation X-Git-Tag: common/v1.0.26~4^2 X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=commitdiff_plain;h=f928074586ae5ef99d293be636ba12cae9f5be7f;p=ric-plt%2Fnodeb-rnib.git Configure Repo for Documentation Change-Id: Id392e0636e75ddf5fabb82f294d028e4add2dca5 Signed-off-by: nm755n --- diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..9c14461 --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +# 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 Binary files /dev/null and b/docs/_static/logo.png differ diff --git a/docs/api-docs.rst b/docs/api-docs.rst deleted file mode 100644 index 832b4b3..0000000 --- a/docs/api-docs.rst +++ /dev/null @@ -1,41 +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 -============ - -.. note - -.. This section is used to describe a software API exposed from a O-RAN software component. - -.. This note must be removed after content has been added. - - -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..6f0b9ad --- /dev/null +++ b/docs/conf.yaml @@ -0,0 +1,3 @@ +--- +project_cfg: oran +project: ric-plt/nodeb-rnib 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 Binary files /dev/null and b/docs/favicon.ico differ diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..3266c13 --- /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/nodeb-rnib 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 , 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 -============ -.. - -.: - -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 -======= -.. - -: - -Before starting the installation of , some planning must preceed. - -.. note:any preperation you need before setting up sotfware and hardware - - -Hardware requirements -===================== -.. - -: - -Following minimum hardware requirements must be met for installation of : - -+--------------------+----------------------------------------------------+ -| **HW Aspect** | **Requirement** | -| | | -+--------------------+----------------------------------------------------+ -| **# of servers** | | -+--------------------+----------------------------------------------------+ -| **CPU** | | -| | | -+--------------------+----------------------------------------------------+ -| **RAM** | | -| | | -+--------------------+----------------------------------------------------+ -| **Disk** | | -| | | -+--------------------+----------------------------------------------------+ -| **NICs** | | -| | | -| | | -| | | -| | | -| | | -+--------------------+----------------------------------------------------+ - - - - - -Software installation and deployment -========================================== -.. - -: - -This section describes the installation of the installation on the reference hardware. - - - -References -========== -.. - -: - -OpenStack -^^^^^^^^^^^ - - diff --git a/docs/overview.rst b/docs/overview.rst new file mode 100755 index 0000000..859fae8 --- /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/nodeb-rnib Overview +=========================== diff --git a/docs/release-notes.rst b/docs/release-notes.rst index 9d6b5b2..1a35c8e 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -18,12 +18,9 @@ -This document provides the release notes for of . - -.. contents:: - :depth: 3 - :local: - +nodeb-rnib Release Notes +======================== +The following is a list of release highlights for nodeb-rnib: Version history --------------- @@ -78,7 +75,7 @@ Release Data Feature additions -~~~~~~~~~~~~~~~~~~~~~~~ +----------------- : @@ -99,7 +96,7 @@ Feature additions +--------------------------------------+--------------------------------------+ Bug corrections -~~~~~~~~~~~~~~~~~~~~~ +--------------- **JIRA TICKETS:** @@ -117,17 +114,17 @@ Bug corrections +--------------------------------------+--------------------------------------+ Deliverables ----------------- +------------ Software deliverables -^^^^^^^^^^^^^^^^^^^^^^^ +--------------------- : Documentation deliverables -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +-------------------------- @@ -138,13 +135,13 @@ Known Limitations, Issues and Workarounds ========================================= System Limitations -^^^^^^^^^^^^^^^^^^^^ +------------------ Known issues -^^^^^^^^^^^^^^^ +------------ : @@ -165,7 +162,7 @@ Known issues +--------------------------------------+--------------------------------------+ Workarounds -^^^^^^^^^^^^^^^^^ +----------- 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