From: Roni Riska Date: Wed, 13 Nov 2019 06:33:12 +0000 (+0200) Subject: Add docs building support X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=commitdiff_plain;h=ee366660d79b98913923f00812a4622df29a0f90;p=ric-plt%2Fjaegeradapter.git Add docs building support Change-Id: I3415c0a1d3544fd64e4892b1f84f83739b35df7c Signed-off-by: Roni Riska --- diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..bdb4219 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +.tox +docs/_build/ diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 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/README.md b/README.md index 6f7747d..7dc70d0 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ # Jaeger adapter -This repository contains jaeger configuration files, like the heml charts +This repository contains jaeger configuration files, like the helm charts ## Current information Currently only supported configuration is jaeger-all-in-one deployment. -The heml chart defines following three services. +The helm chart defines following three services. ### The jaeger agent diff --git a/docs/_static/logo.png b/docs/_static/logo.png new file mode 100644 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 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 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 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..b0465f1 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,43 @@ +.. +.. 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. +.. + + +Welcome to O-RAN SC jaegeradapter Documentation +=============================================== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + overview.rst + release-notes.rst + + + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` \ No newline at end of file diff --git a/docs/overview.rst b/docs/overview.rst new file mode 100644 index 0000000..0e4d0fc --- /dev/null +++ b/docs/overview.rst @@ -0,0 +1,33 @@ +.. +.. 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. +.. + + +jaegeradapter Overview +====================== + +This repository contains helm charts for deploying a jaeger-all-in-one container. +In addition, it contains a config map for creating a trace configuration for clients using either ric-plt/tracelibcpp or ric-plt/tracelibgo. diff --git a/docs/release-notes.rst b/docs/release-notes.rst new file mode 100644 index 0000000..ddd9df8 --- /dev/null +++ b/docs/release-notes.rst @@ -0,0 +1,117 @@ +.. +.. 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. +.. + + +Release-Notes +============= + + +This document provides the release notes for version 1.0.0 of jaegeradapter. + +.. contents:: + :depth: 3 + :local: + + +Version history +--------------- + ++--------------------+--------------------+--------------------+--------------------+ +| **Date** | **Ver.** | **Author** | **Comment** | +| | | | | ++--------------------+--------------------+--------------------+--------------------+ +| 2019-11-13 | 0.1.0 | R Riska | First version | +| | | | | ++--------------------+--------------------+--------------------+--------------------+ + + +Summary +------- + +This is the first version of this component. + + + + +Release Data +------------ +This is the first version of this component. +The repository contains jaeger configuration files. +This first version only supports configuration for a jaeger-all-in-one deployment. + + + + +Feature Additions +^^^^^^^^^^^^^^^^^ + +Bug Corrections +^^^^^^^^^^^^^^^ + + +Deliverables +^^^^^^^^^^^^ + +Software Deliverables ++++++++++++++++++++++ + +- Helm charts for deploying a jaeger-all-in-one container +- A config map for creating a trace client configuration for clients using ric-plt/tracelibcpp or ric-plt/tracelibgo + +These components can be retrieved from https://gerrit.o-ran-sc.org/r/ric-plt/jaegeradapter.git. + + + +Documentation Deliverables +++++++++++++++++++++++++++ + + + + + +Known Limitations, Issues and Workarounds +----------------------------------------- + +System Limitations +^^^^^^^^^^^^^^^^^^ + + + +Known Issues +^^^^^^^^^^^^ + +Workarounds +^^^^^^^^^^^ + + + + + +References +---------- + + 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..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