From: elinuxhenrik Date: Thu, 23 Jun 2022 11:24:21 +0000 (+0200) Subject: Update documentation X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=commitdiff_plain;h=196cb83db193a6ba7928344321717fc2d33dcf45;p=nonrtric%2Frapp%2Forufhrecovery.git Update documentation Issue-ID: NONRTRIC-769 Signed-off-by: elinuxhenrik Change-Id: Iea2f46e2d4093a55629b24f60847c88d4fb732a6 --- diff --git a/docs/conf.py b/docs/conf.py index 6655001..28b5fa5 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,7 +1,6 @@ from docs_conf.conf import * #branch configuration - branch = 'latest' linkcheck_ignore = [ @@ -9,3 +8,13 @@ linkcheck_ignore = [ '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 = {} + +intersphinx_mapping['nonrtric'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric/en/%s' % branch, None) diff --git a/docs/index.rst b/docs/index.rst index 679d9a4..eb32c18 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -2,8 +2,8 @@ .. SPDX-License-Identifier: CC-BY-4.0 .. Copyright (C) 2021 Nordix -Non-RT RIC -========== +Non-RT RIC O-RU Fronthaul Recovery Use Case +=========================================== .. toctree:: :maxdepth: 2 @@ -11,5 +11,3 @@ Non-RT RIC ./overview.rst ./release-notes.rst - -* :ref:`search` diff --git a/docs/overview.rst b/docs/overview.rst index 9f7f4a8..dd34e45 100644 --- a/docs/overview.rst +++ b/docs/overview.rst @@ -2,11 +2,8 @@ .. SPDX-License-Identifier: CC-BY-4.0 .. Copyright (C) 2021 Nordix -.. |archpic| image:: ./images/nonrtric-architecture-E.png - :alt: Image: O-RAN SC - NONRTRIC Overall Architecture - -DMaaP Adapter -~~~~~~~~~~~~~ +O-RU Fronthaul Recovery Use Case +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ************ Introduction @@ -21,6 +18,8 @@ script, one utilizing the ONAP Policy Framework, and one Go version that utilize The code is available in the `use case repo `_ +This product is a part of :doc:`NONRTRIC `. + Standalone Script Solution ++++++++++++++++++++++++++