From: Timo Tietavainen Date: Wed, 13 Nov 2019 10:18:10 +0000 (+0000) Subject: Merge "Add documentation files" X-Git-Tag: v0.5.2~1 X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=commitdiff_plain;h=5234ad73f3f32c24769e8f233ce7b10c11602149;hp=d2a44e5c41e5ebc1fae14ae75582a9e3bec27530;p=ric-plt%2Fsdlgo.git Merge "Add documentation files" --- 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..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..80f9699 --- /dev/null +++ b/docs/conf.yaml @@ -0,0 +1,3 @@ +--- +project_cfg: oran +project: ric-plt/sdlgo 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..4529a25 --- /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 Go 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..7b53cff --- /dev/null +++ b/docs/release-notes.rst @@ -0,0 +1,81 @@ +.. +.. 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/sdlgo. + +.. contents:: + :depth: 3 + :local: + + + +Version history +--------------- + +[0.5.1] - 2019-11-1 + +* Add CI Dockerfile to run unit tests. + +[0.5.0] - 2019-10-11 + +* Make underlying DB instance visible to clients. + +[0.4.0] - 2019-09-26 + +* Add support for Redis sentinel configuration. + +[0.3.1] - 2019-09-11 + +* Set MaxRetries count to 2 for Redis client. + +[0.3.0] - 2019-08-14 + +* Add support for resource locking to enable applications to create locks for + shared resources. + +[0.2.1] - 2019-07-03 + +* Add support for multiple event publishing. + +[0.2.0] - 2019-05-24 + +* Add support for SDL groups. + +[0.1.1] - 2019-05-17 + +* Allow byte array/slice be given as value. + +[0.1.0] - 2019-05-17 + +* Add support for notifications. + +[0.0.2] - 2019-05-03 + +* Fix Close API call. Calling Close function from API caused a recursive call + to itself. + +[0.0.1] - 2019-04-17 + +* Initial version. +* Implement basic storage functions to create, read, update, and delete + entries. +* Implement benchmark tests. 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