From: JohnKeeney Date: Tue, 25 Apr 2023 15:55:30 +0000 (+0100) Subject: Add ReadTheDocs configuration/site in repo root directory X-Git-Tag: 1.0.0~22 X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=commitdiff_plain;h=fe56ddf0c472e27e2e22d151e19ea7834a3beab3;p=nonrtric%2Fplt%2Franpm.git Add ReadTheDocs configuration/site in repo root directory Issue-ID: NONRTRIC-864 Change-Id: I648b265d07b673eb0a186e78132169c1c541e9e7 Signed-off-by: JohnKeeney --- diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..b595604 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,37 @@ + ============LICENSE_START=============================================== +# Copyright (C) 2019-2023 Nordix Foundation. All rights reserved. +# ======================================================================== +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# 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. +# ============LICENSE_END================================================= +# + +--- +# .readthedocs.yml +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details +# Required +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/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..581378e --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,36 @@ +/* +* ============LICENSE_START========================================== +* Copyright (C) 2018-2023 Nordix Foundation. All rights reserved. +* Copyright (c) 2018 NOKIA Intellectual Property. All rights reserved. +* =================================================================== +* +* Unless otherwise specified, all software contained herein is licensed +* under the Apache License, Version 2.0 (the "License"); +* you may not use this software except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* 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. +* +* +* +* Unless otherwise specified, all documentation contained herein is licensed +* under the Creative Commons License, Attribution 4.0 Intl. (the "License"); +* you may not use this documentation 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. +* +* ============LICENSE_END============================================ +*/ diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..7639988 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,34 @@ +from docs_conf import * + +branch = 'latest' +selfurl = 'https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric-plt-ranpm/en/%s' % branch + +linkcheck_ignore = [ + 'http://localhost.*', + 'http://127.0.0.1.*', + 'https://gerrit.o-ran-sc.org.*' +] + +#branch configuration + + +linkcheck_ignore = [ + 'http://localhost.*', + 'http://127.0.0.1.*', + 'https://gerrit.o-ran-sc.org.*', +] + +extensions = [ + 'sphinx.ext.intersphinx', + 'sphinx.ext.autosectionlabel', +] + +#intershpinx mapping with other projects +#intersphinx_mapping = {} +## Note there is a circular dependency here - sub-project pages must exist before they can be checked +#intersphinx_mapping['influxlogger'] = ('%s/influxlogger' % selfurl, None) +#intersphinx_mapping['datafilecollector'] = ('%s/datafilecollector' % selfurl, None) +#intersphinx_mapping['pmproducer'] = ('%s/pmproducer' % selfurl, None) + + +intersphinx_disabled_reftypes = ["*"] diff --git a/docs/conf.yaml b/docs/conf.yaml new file mode 100644 index 0000000..1396954 --- /dev/null +++ b/docs/conf.yaml @@ -0,0 +1,6 @@ +--- +project_cfg: oran +project: nonrtric-plt-ranpm + +# Change this to ReleaseBranchName to modify the header +default-version: latest 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..8e8fd5b --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,13 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. SPDX-License-Identifier: CC-BY-4.0 +.. Copyright (C) 2021 Nordix + +Non-RT RIC RAN PM Usecase / Functions +=========================================== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + ./overview.rst + ./release-notes.rst diff --git a/docs/overview.rst b/docs/overview.rst new file mode 100644 index 0000000..91310db --- /dev/null +++ b/docs/overview.rst @@ -0,0 +1,14 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. SPDX-License-Identifier: CC-BY-4.0 +.. Copyright (C) 2023 Nordix + +Non-RT RIC RAN PM Usecase/Functions +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Perent repo Non-RT RIC RAN PM Usecase/Functions + +************** +Implementation +************** + +Implemented as multiple functions in sub directories diff --git a/docs/release-notes.rst b/docs/release-notes.rst new file mode 100644 index 0000000..cb0c8cd --- /dev/null +++ b/docs/release-notes.rst @@ -0,0 +1,45 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright (C) 2023 Nordix + +============= +Release-Notes +============= + + +This document provides the release notes for the release of the Non-RT RIC RAN PM Usecase/Functions. + + +Version history RAN PM Usecase/Functions +======================================== + ++------------+----------+------------------+--------------------+ +| **Date** | **Ver.** | **Author** | **Comment** | +| | | | | ++------------+----------+------------------+--------------------+ +| 2023-04-21 | 0.0.0 | John Keeney | Started Docs. | +| | | | Remove this row | ++------------+----------+------------------+--------------------+ + + +Release Data +============ + +H +- ++-----------------------------+---------------------------------------------------+ +| **Project** | Non-RT RIC RAN PM | +| | | ++-----------------------------+---------------------------------------------------+ +| **Repo/commit-ID** | | +| | | ++-----------------------------+---------------------------------------------------+ +| **Release designation** | H | +| | | ++-----------------------------+---------------------------------------------------+ +| **Release date** | 2023-06-xx | +| | | ++-----------------------------+---------------------------------------------------+ +| **Purpose of the delivery** | First release of RAN PM Usecase/Functions | +| | | ++-----------------------------+---------------------------------------------------+ diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt new file mode 100644 index 0000000..ec7ae3e --- /dev/null +++ b/docs/requirements-docs.txt @@ -0,0 +1,13 @@ +tox +Sphinx +doc8 +docutils +setuptools +six +sphinx_rtd_theme +sphinxcontrib-needs +sphinxcontrib-swaggerdoc +sphinx_bootstrap_theme +sphinxcontrib-redoc +lfdocs-conf +sphinx-multiproject diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000..a100413 --- /dev/null +++ b/tox.ini @@ -0,0 +1,42 @@ +# ================================================================================== +# Copyright (c) 2023 Nordix +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# 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. +# ================================================================================== + +[tox] +minversion = 2.0 +envlist = + docs, + docs-linkcheck, + +skipsdist = true + +[testenv:docs] +basepython = python3 +deps = -r{toxinidir}/docs/requirements-docs.txt + +commands = + sphinx-build -W -b html --keep-going -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html + sphinx-build -W -b html --keep-going -n -d {envtmpdir}/datafilecollector/doctrees ./datafilecollector/docs/ {toxinidir}/docs/_build/html/datafilecollector + sphinx-build -W -b html --keep-going -n -d {envtmpdir}/influxlogger/doctrees ./influxlogger/docs/ {toxinidir}/docs/_build/html/influxlogger + sphinx-build -W -b html --keep-going -n -d {envtmpdir}/pmproducer/doctrees ./pmproducer/docs/ {toxinidir}/docs/_build/html/pmproducer + +[testenv:docs-linkcheck] +basepython = python3 +deps = -r{toxinidir}/docs/requirements-docs.txt +commands = + sphinx-build -W -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck + sphinx-build -W -b linkcheck -d {envtmpdir}/datafilecollector/doctrees ./datafilecollector/docs/ {toxinidir}/docs/_build/linkcheck/datafilecollector-withtox + sphinx-build -W -b linkcheck -d {envtmpdir}/influxlogger/doctrees ./influxlogger/docs/ {toxinidir}/docs/_build/linkcheck/influxlogger-withtox + sphinx-build -W -b linkcheck -d {envtmpdir}/pmproducer/doctrees ./pmproducer/docs/ {toxinidir}/docs/_build/linkcheck/pmproducer-withtox