Added mandatory documentation files for the RIC Amber release.
Change-Id: I421945043e573ca72cd56f92d681308cbe98b685
Signed-off-by: Timo Tietavainen <timo.tietavainen@nokia.com>
--- /dev/null
+# documentation
+.tox
+docs/_build/
--- /dev/null
+---
+version: 2
+
+formats:
+ - htmlzip
+
+build:
+ image: latest
+
+python:
+ version: 3.7
+ install:
+ - requirements: docs/requirements-docs.txt
+
+sphinx:
+ configuration: docs/conf.py
--- /dev/null
+from docs_conf.conf import *
+linkcheck_ignore = [
+ 'http://localhost.*',
+ 'http://127.0.0.1.*',
+ 'https://gerrit.o-ran-sc.org.*'
+]
--- /dev/null
+---
+project_cfg: oran
+project: ric-plt/streaming-protobufs
--- /dev/null
+..
+.. 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`
--- /dev/null
+..
+.. 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.
--- /dev/null
+..
+.. 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
--- /dev/null
+sphinx
+sphinx-rtd-theme
+sphinxcontrib-httpdomain
+recommonmark
+lfdocs-conf
--- /dev/null
+# 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
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