DOC: Add branch configuration for ICS

Change-Id: Ifeeda62aabc21395b9a3dd912d5ebcb6e9b4c4e2
Signed-off-by: JohnKeeney <john.keeney@est.tech>
Issue-ID: NONRTRIC-958

diff --git a/docs/conf.py b/docs/conf.py
index 0acbd7b..6d1dc6e 100644 (file)
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -22,11 +22,14 @@
 from docs_conf.conf import *
 
 branch = 'i-release'
 from docs_conf.conf import *
 
 branch = 'i-release'

-subsitesbranch = 'i-release'
+subsitesbranch = 'i-release' # set this to latest for the first build on a new branch. Then change in next commit. 
+icsbranch = 'i-release' 

 
 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)
 
 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.*',
 
 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['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 = ["*"]
 
 intersphinx_disabled_reftypes = ["*"]

diff --git a/docs/overview.rst b/docs/overview.rst
index 5d0043b..cedec15 100644 (file)
--- 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) <pm-file-converter:index>`.
 * :doc:`Non-RT RIC - RAN PM - PM Producer (Documentation site) <pmproducer:index>`.
 * :doc:`Non-RT RIC - RAN PM - Influx Logger (Documentation site) <influxlogger:index>`.
 * :doc:`Non-RT RIC - RAN PM - PM File Converter (Documentation site) <pm-file-converter:index>`.
 * :doc:`Non-RT RIC - RAN PM - PM Producer (Documentation site) <pmproducer:index>`.
 * :doc:`Non-RT RIC - RAN PM - Influx Logger (Documentation site) <influxlogger:index>`.

-* `Non-RT RIC - Information Coordinator Service (Documentation site) <https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric-plt-informationcoordinatorservice/en/latest/>`_.
-*  HTTPS-SERVER TBD
+* :doc:`Non-RT RIC - Information Coordinator Service (Documentation site) <ics:index>`.

 
 *********
 Data Flow
 
 *********
 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.
 **************************************
 
 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) <https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric-plt-informationcoordinatorservice/en/latest/>`_.
+The API documentation is available in :doc:`Non-RT RIC - Information Coordinator Service (Documentation site) <ics:index>`.

 
 The schema for the PM Measurement information jobs is defined in :doc:`Non-RT RIC - RAN PM - PM Producer (Documentation <pmproducer:index>`.
 This schema defines parameters used in the subscription (info job) and defines which measurements to subscribe for and on which
 
 The schema for the PM Measurement information jobs is defined in :doc:`Non-RT RIC - RAN PM - PM Producer (Documentation <pmproducer:index>`.
 This schema defines parameters used in the subscription (info job) and defines which measurements to subscribe for and on which