From: JohnKeeney <john.keeney@est.tech>
Date: Wed, 26 Apr 2023 21:42:08 +0000 (+0100)
Subject: Add ReadTheDocs configuration/site in repo root directory step #4
X-Git-Tag: 1.0.0~16
X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=commitdiff_plain;h=dcecbc9d5e1605e429ce7d27b7201bf7864059ff;p=nonrtric%2Fplt%2Franpm.git

Add ReadTheDocs configuration/site in repo root directory step #4

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

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
index 7f70a29..4225bf6 100644
--- a/.readthedocs.yaml
+++ b/.readthedocs.yaml
@@ -34,9 +34,9 @@ build:
     - mkdir --parents _readthedocs/html/
     - mkdir --parents _readthedocs/tmp/doctrees
     - sphinx-build -W -b html --keep-going -n -d _readthedocs/tmp/doctrees  ./docs/ _readthedocs/html/
-    - sphinx-build -W -b html --keep-going -n -d _readthedocs/tmp/doctrees  ./datafilecollector/docs/ _readthedocs/html/datafilecollector
-    - sphinx-build -W -b html --keep-going -n -d _readthedocs/tmp/doctrees  ./influxlogger/docs/ _readthedocs/html/influxlogger
-    - sphinx-build -W -b html --keep-going -n -d _readthedocs/tmp/doctrees  ./pmproducer/docs/ _readthedocs/html/pmproducer
+    - sphinx-build -W -b html --keep-going -n -d _readthedocs/tmp/doctrees/datafilecollector  ./datafilecollector/docs/ _readthedocs/html/datafilecollector
+    - sphinx-build -W -b html --keep-going -n -d _readthedocs/tmp/doctrees/influxlogger  ./influxlogger/docs/ _readthedocs/html/influxlogger
+    - sphinx-build -W -b html --keep-going -n -d _readthedocs/tmp/doctrees/pmproducer  ./pmproducer/docs/ _readthedocs/html/pmproducer
 
 python:
   install:
diff --git a/docs/conf.py b/docs/conf.py
index 20a35ac..f0e4e4c 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -21,7 +21,8 @@
 from docs_conf.conf import *
 
 branch = 'latest'
-selfurl = 'https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric-plt-ranpm/en/%s' % branch
+baseurl = 'https://docs.o-ran-sc.org/projects/'
+selfurl = '%s/o-ran-sc-nonrtric-plt-ranpm/en/%s' %(baseurl, branch)
 
 linkcheck_ignore = [
     'http://localhost.*',
@@ -35,11 +36,12 @@ extensions = [
 ]
 
 #intershpinx mapping with other projects
-#intersphinx_mapping = {}
+intersphinx_mapping = {}
+intersphinx_mapping['nonrtric'] = ('%s/o-ran-sc-nonrtric/en/%s' %(baseurl, branch), None)
 ## 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_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/overview.rst b/docs/overview.rst
index 91310db..97b1434 100644
--- a/docs/overview.rst
+++ b/docs/overview.rst
@@ -2,13 +2,18 @@
 .. SPDX-License-Identifier: CC-BY-4.0
 .. Copyright (C) 2023 Nordix
 
-Non-RT RIC RAN PM Usecase/Functions
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Non-RT RIC RAN PM Use-case/Functions
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Perent repo Non-RT RIC RAN PM Usecase/Functions
+Parent repo Non-RT RIC RAN PM Use-case/Functions
 
 **************
 Implementation
 **************
 
-Implemented as multiple functions in sub directories
+Implemented as multiple functions in sub directories:
+
+* :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 Data File Collector (Documentation site) <datafilecollector:index>`.
+