From: Timo Tietavainen Date: Wed, 13 Nov 2019 05:59:50 +0000 (+0200) Subject: Add documentation files X-Git-Tag: 1.2.1~17^2 X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=commitdiff_plain;h=e23a068afac8dc595a2837b73ffd804c481b88ef;p=ric-plt%2Fsdl.git Add documentation files Added mandatory documentation files for the RIC Amber release. Change-Id: I8d2b1a9ca9bd01f18082e338cbfd2e044c96b334 Signed-off-by: Timo Tietavainen --- diff --git a/.gitignore b/.gitignore index e354e78..c11b9dd 100644 --- a/.gitignore +++ b/.gitignore @@ -37,6 +37,8 @@ /doxygen-doc/ /run-tests.sh /testrunner +.tox +docs/_build/ *.log *.trs *.sw* 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/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..27964df --- /dev/null +++ b/docs/conf.yaml @@ -0,0 +1,3 @@ +--- +project_cfg: oran +project: ric-plt/sdl 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..b59ea12 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,31 @@ +.. +.. 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 Shared Data Layer (SDL) in C++ Documentation +============================================================= + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + overview.rst + release-notes.rst + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/docs/overview.rst b/docs/overview.rst new file mode 100644 index 0000000..63a2f4f --- /dev/null +++ b/docs/overview.rst @@ -0,0 +1,25 @@ +.. +.. 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. +.. + +Overview +======== + +Shared Data Layer provides a lightweight, high-speed interface for accessing +shared data storage. The purpose is to enable utilizing clients to become +stateless, conforming with, e.g., the requirements of the fifth generation +mobile networks. diff --git a/docs/release-notes.rst b/docs/release-notes.rst new file mode 100644 index 0000000..9a6ec6e --- /dev/null +++ b/docs/release-notes.rst @@ -0,0 +1,56 @@ +.. +.. 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 O-RAN SC Amber release of +ric-plt/sdl. + +.. contents:: + :depth: 3 + :local: + + + +Version history +--------------- + +[1.0.3] - 2019-11-08 + +* Add CI Dockerfile to compile SDL library and run unit tests. +* Remove AX_PTHREAD autoconf macro due to incompatible license. + +[1.0.2] - 2019-10-02 + +* Take standard stream logger into use. + +[1.0.1] - 2019-10-01 + +* Add support for Redis Sentinel based database discovery, which usage can be + activated via environment variables. +* Add Sentinel change notification handling logic. +* Unit test fix for a false positive warning, when'EXPECT_EQ' macro is used + to validate boolean value. + +[1.0.0] - 2019-08-20 + +* Initial version. +* Take Google's C++ unit test framework into use. +* Implement basic storage operations to create, read, update, and delete + entries. 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..c86cfdf --- /dev/null +++ b/tox.ini @@ -0,0 +1,30 @@ +# documentation only +[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