From 75a5bdd0a4b9c4471b9a1673483e3ec55fdc53a6 Mon Sep 17 00:00:00 2001 From: JohnKeeney Date: Tue, 16 May 2023 18:19:52 +0100 Subject: [PATCH] Docs: Small updates to get site to generate Issue-ID: NONRTRIC-864 Change-Id: Ic50f95b2c91ed3777f1a2a7aeb0a8d026c822380 Signed-off-by: JohnKeeney --- datafilecollector/docs/requirements-docs.txt | 3 ++- docs/conf.py | 2 +- docs/overview.rst | 6 +++--- influxlogger/docs/requirements-docs.txt | 3 ++- pm-file-converter/{container.yaml => container-tag.yaml} | 0 pm-file-converter/docs/conf.yaml | 2 +- pm-file-converter/docs/requirements-docs.txt | 3 ++- pmproducer/docs/requirements-docs.txt | 3 ++- tox.ini | 1 + 9 files changed, 14 insertions(+), 9 deletions(-) rename pm-file-converter/{container.yaml => container-tag.yaml} (100%) diff --git a/datafilecollector/docs/requirements-docs.txt b/datafilecollector/docs/requirements-docs.txt index f266a10..f90f2a0 100644 --- a/datafilecollector/docs/requirements-docs.txt +++ b/datafilecollector/docs/requirements-docs.txt @@ -9,4 +9,5 @@ sphinxcontrib-needs sphinxcontrib-swaggerdoc sphinx_bootstrap_theme sphinxcontrib-redoc -lfdocs-conf \ No newline at end of file +lfdocs-conf +urllib3~=1.26.15 \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py index ff87b2b..93ba261 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -42,6 +42,6 @@ intersphinx_mapping['nonrtric'] = ('%s/o-ran-sc-nonrtric/en/%s' %(baseurl, branc intersphinx_mapping['influxlogger'] = ('%s/influxlogger' % selfurl, None) intersphinx_mapping['datafilecollector'] = ('%s/datafilecollector' % selfurl, None) intersphinx_mapping['pmproducer'] = ('%s/pmproducer' % selfurl, None) -intersphinx_mapping['pm-file-converter'] = ('%s/pm-file-converter' % selfurl, None) +#intersphinx_mapping['pm-file-converter'] = ('%s/pm-file-converter' % selfurl, None) intersphinx_disabled_reftypes = ["*"] diff --git a/docs/overview.rst b/docs/overview.rst index f6ea5ce..526d9c5 100644 --- a/docs/overview.rst +++ b/docs/overview.rst @@ -43,15 +43,15 @@ The third party products used are: For more detailed documentation of the components: +.. Commented out until the site exists for the first time + * :doc:`Non-RT RIC - RAN PM - PM File Converter (Documentation site) `. + * :doc:`Non-RT RIC - RAN PM - PM Data File Collector (Documentation site) `. -* :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 - - ********* Data Flow ********* diff --git a/influxlogger/docs/requirements-docs.txt b/influxlogger/docs/requirements-docs.txt index f266a10..f90f2a0 100644 --- a/influxlogger/docs/requirements-docs.txt +++ b/influxlogger/docs/requirements-docs.txt @@ -9,4 +9,5 @@ sphinxcontrib-needs sphinxcontrib-swaggerdoc sphinx_bootstrap_theme sphinxcontrib-redoc -lfdocs-conf \ No newline at end of file +lfdocs-conf +urllib3~=1.26.15 \ No newline at end of file diff --git a/pm-file-converter/container.yaml b/pm-file-converter/container-tag.yaml similarity index 100% rename from pm-file-converter/container.yaml rename to pm-file-converter/container-tag.yaml diff --git a/pm-file-converter/docs/conf.yaml b/pm-file-converter/docs/conf.yaml index 9f420ed..6e6baed 100644 --- a/pm-file-converter/docs/conf.yaml +++ b/pm-file-converter/docs/conf.yaml @@ -1,3 +1,3 @@ --- project_cfg: oran -project: nonrtric-plt-pmdataconverter +project: nonrtric-plt-pm-file-converter diff --git a/pm-file-converter/docs/requirements-docs.txt b/pm-file-converter/docs/requirements-docs.txt index f266a10..f90f2a0 100644 --- a/pm-file-converter/docs/requirements-docs.txt +++ b/pm-file-converter/docs/requirements-docs.txt @@ -9,4 +9,5 @@ sphinxcontrib-needs sphinxcontrib-swaggerdoc sphinx_bootstrap_theme sphinxcontrib-redoc -lfdocs-conf \ No newline at end of file +lfdocs-conf +urllib3~=1.26.15 \ No newline at end of file diff --git a/pmproducer/docs/requirements-docs.txt b/pmproducer/docs/requirements-docs.txt index f266a10..f90f2a0 100644 --- a/pmproducer/docs/requirements-docs.txt +++ b/pmproducer/docs/requirements-docs.txt @@ -9,4 +9,5 @@ sphinxcontrib-needs sphinxcontrib-swaggerdoc sphinx_bootstrap_theme sphinxcontrib-redoc -lfdocs-conf \ No newline at end of file +lfdocs-conf +urllib3~=1.26.15 \ No newline at end of file diff --git a/tox.ini b/tox.ini index e26163d..257a026 100644 --- a/tox.ini +++ b/tox.ini @@ -45,4 +45,5 @@ 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}/pm-file-converter/doctrees ./pm-file-converter/docs/ {toxinidir}/docs/_build/linkcheck/pm-file-converter sphinx-build -W -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck -- 2.16.6