--- /dev/null
+.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 tracelibcpp 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
+tracelibcpp Overview\r
+====================\r
+\r
+This library implements a function for creating a configured tracer instance.\r
+It hides the underlaying tracer implementation from the application.\r
+The library currently supports only Jaeger (https://www.jaegertracing.io/) C++ client (https://github.com/jaegertracing/jaeger-client-cpp) tracer implementation.\r
--- /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
+Release-Notes\r
+=============\r
+\r
+\r
+This document provides the release notes for v0.0.4 of tracelibcpp.\r
+\r
+.. contents::\r
+ :depth: 3\r
+ :local:\r
+\r
+\r
+Version history\r
+---------------\r
+\r
++--------------------+--------------------+--------------------+--------------------+\r
+| **Date** | **Ver.** | **Author** | **Comment** |\r
+| | | | |\r
++--------------------+--------------------+--------------------+--------------------+\r
+| 2019-09-04 | 0.0.4 | R Riska | First version |\r
+| | | | |\r
++--------------------+--------------------+--------------------+--------------------+\r
+\r
+\r
+Summary\r
+-------\r
+\r
+This is the first version of this library.\r
+It implements a function for creating a configured tracer instance.\r
+\r
+\r
+\r
+\r
+Release Data\r
+------------\r
+\r
+This is the first version of this library.\r
+\r
+\r
+\r
+Feature Additions\r
+^^^^^^^^^^^^^^^^^\r
+\r
+Bug Corrections\r
+^^^^^^^^^^^^^^^\r
+\r
+\r
+Deliverables\r
+^^^^^^^^^^^^\r
+\r
+Software Deliverables\r
++++++++++++++++++++++\r
+\r
+This version contains:\r
+\r
+- tracelibcpp/tracelibcpp.hpp header file\r
+- tracelibcpp library\r
+\r
+It can be retrieved from https://gerrit.o-ran-sc.org/r/ric-plt/tracelibcpp.git.\r
+\r
+\r
+Documentation Deliverables\r
+++++++++++++++++++++++++++\r
+\r
+\r
+\r
+\r
+\r
+Known Limitations, Issues and Workarounds\r
+-----------------------------------------\r
+\r
+System Limitations\r
+^^^^^^^^^^^^^^^^^^\r
+\r
+\r
+\r
+Known Issues\r
+^^^^^^^^^^^^\r
+\r
+Workarounds\r
+^^^^^^^^^^^\r
+\r
+\r
+\r
+\r
+\r
+References\r
+----------\r
+\r
+\r
--- /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