Currenly only minimal release notes is included.
Change-Id: Ie2ff83f8ee458f9d659b009088c46a8fdbb3ca97
Signed-off-by: Roni Riska <roni.riska@nokia.com>
+# 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: com-golog
--- /dev/null
+..\r
+.. Copyright (c) 2019 AT&T Intellectual Property.\r
+..\r
+.. Copyright (c) 2019 Nokia.\r
+..\r
+..\r
+.. Licensed under the Creative Commons Attribution 4.0 International\r
+..\r
+.. Public License (the "License"); you may not use this file except\r
+..\r
+.. in compliance with the License. You may obtain a copy of the License at\r
+..\r
+..\r
+.. https://creativecommons.org/licenses/by/4.0/\r
+..\r
+..\r
+.. Unless required by applicable law or agreed to in writing, documentation\r
+..\r
+.. distributed under the License is distributed on an "AS IS" BASIS,\r
+..\r
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
+..\r
+.. See the License for the specific language governing permissions and\r
+..\r
+.. limitations under the License.\r
+..\r
+\r
+\r
+Welcome to O-RAN SC golog Documentation\r
+=======================================\r
+\r
+.. toctree::\r
+ :maxdepth: 2\r
+ :caption: Contents:\r
+\r
+ overview.rst\r
+ release-notes.rst\r
+\r
+\r
+\r
+* :ref:`genindex`\r
+* :ref:`modindex`\r
+* :ref:`search`
\ No newline at end of file
--- /dev/null
+..\r
+.. Copyright (c) 2019 AT&T Intellectual Property.\r
+..\r
+.. Copyright (c) 2019 Nokia.\r
+..\r
+..\r
+.. Licensed under the Creative Commons Attribution 4.0 International\r
+..\r
+.. Public License (the "License"); you may not use this file except\r
+..\r
+.. in compliance with the License. You may obtain a copy of the License at\r
+..\r
+..\r
+.. https://creativecommons.org/licenses/by/4.0/\r
+..\r
+..\r
+.. Unless required by applicable law or agreed to in writing, documentation\r
+..\r
+.. distributed under the License is distributed on an "AS IS" BASIS,\r
+..\r
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
+..\r
+.. See the License for the specific language governing permissions and\r
+..\r
+.. limitations under the License.\r
+..\r
+\r
+\r
+golog Overview\r
+==============\r
+\r
+A Golang implementation of a structured logging library with Mapped Diagnostics Context (MDC) support.
\ No newline at end of file
--- /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 v1.0.0 of golog.
+
+.. contents::
+ :depth: 3
+ :local:
+
+
+Version history
+---------------
+
++--------------------+--------------------+--------------------+--------------------+
+| **Date** | **Ver.** | **Author** | **Comment** |
+| | | | |
++--------------------+--------------------+--------------------+--------------------+
+| 2019-11-12 | 1.0.0 | R Riska | First version |
+| | | | |
++--------------------+--------------------+--------------------+--------------------+
+
+
+Summary
+-------
+
+This is the first version of this package.
+
+
+
+
+Release Data
+------------
+This is the first version of this package.
+It contains a Golang implementation of a structured logging library with Mapped Diagnostics Context (MDC) support.
+
+
+
+
+Feature Additions
+^^^^^^^^^^^^^^^^^
+
+Bug Corrections
+^^^^^^^^^^^^^^^
+
+Deliverables
+^^^^^^^^^^^^
+
+Software Deliverables
++++++++++++++++++++++
+
+This version provides Golang package mdcloggo.
+It can be retrieved from https://gerrit.o-ran-sc.org/r/com/golog.git.
+
+
+
+Documentation Deliverables
+++++++++++++++++++++++++++
+
+
+
+
+Known Limitations, Issues and Workarounds
+-----------------------------------------
+
+System Limitations
+^^^^^^^^^^^^^^^^^^
+
+
+
+Known Issues
+^^^^^^^^^^^^
+
+Workarounds
+^^^^^^^^^^^
+
+
+
+
+
+References
+----------
+
+
--- /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]
+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