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

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

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

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
index 531085c..595dc8c 100644
--- a/.readthedocs.yaml
+++ b/.readthedocs.yaml
@@ -16,18 +16,35 @@
 #
 
 ---
+# .readthedocs.yml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
 version: 2
 
 formats:
   - htmlzip
 
 build:
-  image: latest
+  os: ubuntu-22.04
+  tools:
+    python: "3.7"
+  jobs:
+    pre_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  _readthedocs/html/pmproducer
 
 python:
   version: 3.7
   install:
     - requirements: docs/requirements-docs.txt
+    - requirements: datafilecollector/docs/requirements-docs.txt 
+    - requirements: influxlogger/docs/requirements-docs.txt 
+    - requirements: pmproducer/docs/requirements-docs.txt 
 
 sphinx:
   configuration: docs/conf.py
diff --git a/docs/_static/logo.png b/docs/_static/logo.png
new file mode 100644
index 0000000..c3b6ce5
Binary files /dev/null and b/docs/_static/logo.png differ
diff --git a/docs/conf.py b/docs/conf.py
index 3d84e2c..85dff52 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -15,7 +15,10 @@
 #  ============LICENSE_END=================================================
 #
 
-from docs_conf import *
+# NB: This is the only conf.yaml file used by the upstream readthedocs job  (ref '.readthedoc.yaml') 
+#   Where possible include contents of the sub-folders' 'conf.yaml' files here if appropriate 
+
+from docs_conf.conf import *
 
 branch = 'latest'
 selfurl = 'https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric-plt-ranpm/en/%s' % branch
@@ -33,7 +36,7 @@ extensions = [
 
 #intershpinx mapping with other projects
 #intersphinx_mapping = {}
-## Note there is a circular dependency here - sub-project pages must exist before they can be checked 
+## 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)
diff --git a/tox.ini b/tox.ini
index 02c8375..82366e5 100644
--- a/tox.ini
+++ b/tox.ini
@@ -14,12 +14,12 @@
 #   limitations under the License.
 # ==================================================================================
 
-# documentation only
 [tox]
 minversion = 2.0
 envlist =
     docs,
     docs-linkcheck,
+
 skipsdist = true
 
 [testenv:docs]
@@ -31,16 +31,16 @@ deps =
     -r{toxinidir}/pmproducer/docs/requirements-docs.txt 
     
 commands =
-    sphinx-build -W -b html --keep-going -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
     sphinx-build -W -b html --keep-going -n -d {envtmpdir}/datafilecollector/doctrees ./datafilecollector/docs/ {toxinidir}/docs/_build/html/datafilecollector
     sphinx-build -W -b html --keep-going -n -d {envtmpdir}/influxlogger/doctrees ./influxlogger/docs/ {toxinidir}/docs/_build/html/influxlogger
     sphinx-build -W -b html --keep-going -n -d {envtmpdir}/pmproducer/doctrees ./pmproducer/docs/ {toxinidir}/docs/_build/html/pmproducer
+    sphinx-build -W -b html --keep-going -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
 
 [testenv:docs-linkcheck]
 basepython = python3
 deps = -r{toxinidir}/docs/requirements-docs.txt
 commands = 
+    sphinx-build -W -b linkcheck -d {envtmpdir}/datafilecollector/doctrees ./datafilecollector/docs/ {toxinidir}/docs/_build/linkcheck/datafilecollector
+    sphinx-build -W -b linkcheck -d {envtmpdir}/influxlogger/doctrees ./influxlogger/docs/ {toxinidir}/docs/_build/linkcheck/influxlogger
+    sphinx-build -W -b linkcheck -d {envtmpdir}/pmproducer/doctrees ./pmproducer/docs/ {toxinidir}/docs/_build/linkcheck/pmproducer
     sphinx-build -W -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck
-    sphinx-build -W -b linkcheck -d {envtmpdir}/datafilecollector/doctrees ./datafilecollector/docs/ {toxinidir}/docs/_build/linkcheck/datafilecollector-withtox
-    sphinx-build -W -b linkcheck -d {envtmpdir}/influxlogger/doctrees ./influxlogger/docs/ {toxinidir}/docs/_build/linkcheck/influxlogger-withtox
-    sphinx-build -W -b linkcheck -d {envtmpdir}/pmproducer/doctrees ./pmproducer/docs/ {toxinidir}/docs/_build/linkcheck/pmproducer-withtox