From fac3b32c939473cb4f1ae9c0730937eedf575f51 Mon Sep 17 00:00:00 2001 From: JohnKeeney Date: Fri, 15 Dec 2023 23:37:52 +0000 Subject: [PATCH] Docs: Add branch configuration for ICS Change-Id: I54943eebc1ce821cf0d47fb959daa1833f70295b Signed-off-by: JohnKeeney Issue-ID: NONRTRIC-958 --- docs/conf.py | 4 ++++ docs/overview.rst | 5 ++--- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index f806a4b..54a657f 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -23,10 +23,13 @@ from docs_conf.conf import * branch = 'latest' subsitesbranch = 'latest' # set this to latest for the first build on a new branch. Then change in next commit. +icsbranch = 'latest' baseurl = 'https://docs.o-ran-sc.org/projects/' selfurl = '%s/o-ran-sc-nonrtric-plt-ranpm/en/%s' %(baseurl, branch) subsitesurl = '%s/o-ran-sc-nonrtric-plt-ranpm/en/%s' %(baseurl, subsitesbranch) +icsurl = '%s/o-ran-sc-nonrtric-plt-informationcoordinatorservice/en/%s' %(baseurl, subsitesbranch) + linkcheck_ignore = [ 'http://localhost.*', @@ -47,5 +50,6 @@ intersphinx_mapping['influxlogger'] = ('%s/influxlogger' %subsitesurl, None) intersphinx_mapping['datafilecollector'] = ('%s/datafilecollector' %subsitesurl, None) intersphinx_mapping['pmproducer'] = ('%s/pmproducer' %subsitesurl, None) intersphinx_mapping['pm-file-converter'] = ('%s/pm-file-converter' %subsitesurl, None) +intersphinx_mapping['ics'] = ('%s' %icsurl, None) intersphinx_disabled_reftypes = ["*"] diff --git a/docs/overview.rst b/docs/overview.rst index 5d0043b..cedec15 100644 --- a/docs/overview.rst +++ b/docs/overview.rst @@ -47,8 +47,7 @@ For more detailed documentation of the components: * :doc:`Non-RT RIC - RAN PM - PM File Converter (Documentation site) `. * :doc:`Non-RT RIC - RAN PM - PM Producer (Documentation site) `. * :doc:`Non-RT RIC - RAN PM - Influx Logger (Documentation site) `. -* `Non-RT RIC - Information Coordinator Service (Documentation site) `_. -* HTTPS-SERVER TBD +* :doc:`Non-RT RIC - Information Coordinator Service (Documentation site) `. ********* Data Flow @@ -96,7 +95,7 @@ PM Subscriber design time dependencies ************************************** An rApp uses the ICS API to create and manage the subscription of PM Measurements. -The API documentation is available in `Non-RT RIC - Information Coordinator Service (Doc site) `_. +The API documentation is available in :doc:`Non-RT RIC - Information Coordinator Service (Documentation site) `. The schema for the PM Measurement information jobs is defined in :doc:`Non-RT RIC - RAN PM - PM Producer (Documentation `. This schema defines parameters used in the subscription (info job) and defines which measurements to subscribe for and on which -- 2.16.6