From: elinuxhenrik Date: Tue, 14 Apr 2020 08:59:36 +0000 (+0200) Subject: Add links to new API documentation X-Git-Tag: 2.0.0~77 X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=commitdiff_plain;h=0a4c38bb5bfc553c6515a447bb70824988830f84;p=nonrtric.git Add links to new API documentation Change-Id: I1b7507a3d9648c22e71f7b5d292305b6bbb3ae1e Issue-ID: NONRTRIC-152 Signed-off-by: elinuxhenrik --- diff --git a/docs/api-docs.rst b/docs/api-docs.rst index a4cdf08a..d2397ee7 100644 --- a/docs/api-docs.rst +++ b/docs/api-docs.rst @@ -45,6 +45,13 @@ Complementary tools There are two additional tools that can be used together with the Non-RT RIC, namely the Control Panel and the Near-RT RIC simulator. The Non-RT RIC Control Panel provides a user interface that allows the user to interact with the Non-RT RIC. -It can be downloaded using: git clone "https://gerrit.o-ran-sc.org/r/portal/nonrtric-controlpanel" +Documentation for the Control Panel can be found here: +:doc:`Non-RT RIC Control Panel `. +It can be downloaded from here: :: -The Near-RT RIC simulator does what its name suggests, and can be downloaded here: git clone "https://gerrit.o-ran-sc.org/r/sim/a1-interface" + git clone "https://gerrit.o-ran-sc.org/r/portal/nonrtric-controlpanel". + +The Near-RT RIC simulator simulates an A1 protocol termination endpoint. Documentation for the simulator can be found +here: :doc:`A1 Interface Simulator `. It can be downloaded from here: :: + + git clone "https://gerrit.o-ran-sc.org/r/sim/a1-interface" diff --git a/docs/conf.py b/docs/conf.py index 922e22fb..d6202898 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,6 +1,17 @@ from docs_conf.conf import * + +#branch configuration + +branch = 'latest' + linkcheck_ignore = [ 'http://localhost.*', 'http://127.0.0.1.*', 'https://gerrit.o-ran-sc.org.*' ] + +#intershpinx mapping with other projects +intersphinx_mapping = {} + +intersphinx_mapping['nonrtric-controlpanel'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-portal-nonrtric-controlpanel/en/%s' % branch, None) +intersphinx_mapping['sim-a1-interface'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-sim-a1-interface/en/%s' % branch, None) diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst index 54023287..549662d3 100644 --- a/docs/developer-guide.rst +++ b/docs/developer-guide.rst @@ -1,5 +1,6 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. SPDX-License-Identifier: CC-BY-4.0 +.. Copyright (C) 2020 Nordix Developer Guide =============== diff --git a/docs/installation-guide.rst b/docs/installation-guide.rst index 973319b5..26c9133f 100644 --- a/docs/installation-guide.rst +++ b/docs/installation-guide.rst @@ -1,7 +1,6 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 - - +.. Copyright (C) 2020 Nordix Installation Guide ================== diff --git a/docs/overview.rst b/docs/overview.rst index 16274758..2c51dbae 100644 --- a/docs/overview.rst +++ b/docs/overview.rst @@ -1,6 +1,6 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. SPDX-License-Identifier: CC-BY-4.0 - +.. Copyright (C) 2020 Nordix Requirements for the Non-RT RIC project ========================================== diff --git a/docs/policy-agent-api.rst b/docs/policy-agent-api.rst index 2a79b26e..4792bef8 100644 --- a/docs/policy-agent-api.rst +++ b/docs/policy-agent-api.rst @@ -1,5 +1,6 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 +.. Copyright (C) 2020 Nordix .. |nbsp| unicode:: 0xA0 :trim: diff --git a/docs/release-notes.rst b/docs/release-notes.rst index a993a7f9..56888432 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -1,5 +1,6 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 +.. Copyright (C) 2020 Nordix ============= Release-Notes diff --git a/tox.ini b/tox.ini index c86cfdf3..4491722a 100644 --- a/tox.ini +++ b/tox.ini @@ -1,3 +1,19 @@ +# ================================================================================== +# Copyright (c) 2020 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. +# ================================================================================== + # documentation only [tox] minversion = 2.0