From: Timo Tietavainen Date: Thu, 14 Nov 2019 12:41:12 +0000 (+0200) Subject: Add documentation files X-Git-Tag: v0.2.2^0 X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?p=ric-plt%2Fstreaming-protobufs.git;a=commitdiff_plain;h=fc5ba23aa0f5d08400a0eb7c74b0b784b7bf8b72 Add documentation files Added mandatory documentation files for the RIC Amber release. Change-Id: I421945043e573ca72cd56f92d681308cbe98b685 Signed-off-by: Timo Tietavainen --- 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..bc1b4c9 --- /dev/null +++ b/docs/conf.yaml @@ -0,0 +1,3 @@ +--- +project_cfg: oran +project: ric-plt/streaming-protobufs 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..8b5d65b --- /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 Streaming Protobufs 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..ca2c6ae --- /dev/null +++ b/docs/overview.rst @@ -0,0 +1,23 @@ +.. +.. 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 +======== + +Streaming Protobufs provides a Protobuf schema for selected set of X2 +Application Protocol messages. diff --git a/docs/release-notes.rst b/docs/release-notes.rst new file mode 100644 index 0000000..0616239 --- /dev/null +++ b/docs/release-notes.rst @@ -0,0 +1,65 @@ +.. +.. 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/streaming-protobufs. + +.. contents:: + :depth: 3 + :local: + + + +Version history +--------------- + +[0.2.2] - 2019-11-14 + +* Add mandatory documentation files. +* Fix Protobuf version number in x2ap_streaming.proto file. + +[0.2.1] - 2019-10-16 + +* Fix protobuf definition of PLMN-Identity-EUTRA-5GC. + +[0.2.0] - 2019-10-11 + +* Initial version. +* Implement Protobuf schema for following X2AP messages: + + * SGNB ADDITION REQUEST + * SGNB ADDITION REQUEST ACKNOWLEDGE + * SGNB ADDITION REQUEST REJECT + * SGNB RECONFIGURATION COMPLETE + * RRC TRANSFER + * UE CONTEXT RELEASE + * SGNB RELEASE REQUEST + * SGNB RELEASE REQUEST ACKNOWLEDGE + * SGNB RELEASE REQUIRED + * SGNB RELEASE CONFIRM + * SGNB MODIFICATION REQUEST + * SGNB MODIFICATION REQUEST REJECT + * SGNB MODIFICATION REQUEST ACKNOWLEDGE + * SGNB MODIFICATION REQUIRED + * SGNB MODIFICATION CONFIRM + * SGNB MODIFICATION REFUSE + * SN STATUS TRANSFER + * SECONDARY RAT DATA USAGE REPORT 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 diff --git a/x2ap_streaming.proto b/x2ap_streaming.proto index e402415..017cd20 100644 --- a/x2ap_streaming.proto +++ b/x2ap_streaming.proto @@ -55,7 +55,7 @@ import "secondary_rat_data_usage_report.proto"; Dashes converted to underscores to make protobuf message syntax correct. Revision number of this X2AP Streaming protobuf file is: - x2ap_streaming_protobuf_revision: v0.2.0 + x2ap_streaming_protobuf_revision: v0.2.2 The location of X2AP Streaming protobuf files is a Linux Foundation repository: https://gerrit.o-ran-sc.org/r/ric-plt/streaming-protobufs