Docs: Fix broken links and modernise extensions

Replace the abandoned sphinxcontrib-blockdiag and sphinxcontrib-seqdiag
Sphinx extensions with sphinxcontrib-mermaid in docs configuration.

Fix broken GitHub URLs in participant-sim.json OpenAPI spec where
the directory was renamed from policy-clamp-participant-impl-simulator
to participant-impl-simulator. Also fix typo in description field.

Fix broken EclipseLink URL in APEX-Policy-Guide.rst.

Issue-ID: CIMAN-33
Change-Id: I488b1ff5a6ef4a33403d305f69b75d5897568c88
Co-Authored-By: Claude <noreply@anthropic.com>
Signed-off-by: Matthew Watkins <mwatkins@linuxfoundation.org>

diff --git a/docs/apex/APEX-Policy-Guide.rst b/docs/apex/APEX-Policy-Guide.rst
index 2c3c684..e00e51c 100644 (file)
--- a/docs/apex/APEX-Policy-Guide.rst
+++ b/docs/apex/APEX-Policy-Guide.rst
@@ -253,7 +253,7 @@ Concepts and Keys
   Each concept in the model is also a JPA
   (`Java Persistence API <https://en.wikipedia.org/wiki/Java_Persistence_API>`__) Entity. This means that every concept
   can be individually persisted or the entire model can be persisted en-bloc to any persistence mechanism using an JPA
-  framework such as `Hibernate <http://hibernate.org/>`__ or `EclipseLink <http://www.eclipse.org/eclipselink/>`__.
+  framework such as `Hibernate <http://hibernate.org/>`__ or `EclipseLink <https://projects.eclipse.org/projects/ee4j.eclipselink>`__.
 
 Concept: PolicyModel
 ====================

diff --git a/docs/clamp/acm/design-impl/participants/swagger/participant-sim.json b/docs/clamp/acm/design-impl/participants/swagger/participant-sim.json
index 3be2d34..3e8e6da 100644 (file)
--- a/docs/clamp/acm/design-impl/participants/swagger/participant-sim.json
+++ b/docs/clamp/acm/design-impl/participants/swagger/participant-sim.json
@@ -41,7 +41,7 @@
                 ],
                 "responses": {
                     "200": {
-                        "description": "OK, reutrns a serialised instance of [SimConfig](https://github.com/onap/policy-clamp/blob/master/participant/participant-impl/policy-clamp-participant-impl-simulator/src/main/java/org/onap/policy/clamp/acm/participant/sim/model/SimConfig.java)",
+                        "description": "OK, returns a serialised instance of [SimConfig](https://github.com/onap/policy-clamp/blob/master/participant/participant-impl/participant-impl-simulator/src/main/java/org/onap/policy/clamp/acm/participant/sim/model/SimConfig.java)",
                         "content": {
                             "application/json": {
                                 "schema": {
@@ -164,7 +164,7 @@
                 ],
                 "responses": {
                     "200": {
-                        "description": "Serialised instance of [InternalDatas](https://github.com/onap/policy-clamp/blob/master/participant/participant-impl/policy-clamp-participant-impl-simulator/src/main/java/org/onap/policy/clamp/acm/participant/sim/model/InternalDatas.java)",
+                        "description": "Serialised instance of [InternalDatas](https://github.com/onap/policy-clamp/blob/master/participant/participant-impl/participant-impl-simulator/src/main/java/org/onap/policy/clamp/acm/participant/sim/model/InternalDatas.java)",
                         "content": {
                             "application/json": {
                                 "schema": {
@@ -287,7 +287,7 @@
                 ],
                 "responses": {
                     "200": {
-                        "description": "Serialised instance of [InternalDatas](https://github.com/onap/policy-clamp/blob/master/participant/participant-impl/policy-clamp-participant-impl-simulator/src/main/java/org/onap/policy/clamp/acm/participant/sim/model/InternalDatas.java)",
+                        "description": "Serialised instance of [InternalDatas](https://github.com/onap/policy-clamp/blob/master/participant/participant-impl/participant-impl-simulator/src/main/java/org/onap/policy/clamp/acm/participant/sim/model/InternalDatas.java)",
                         "content": {
                             "application/json": {
                                 "schema": {

diff --git a/docs/conf.py b/docs/conf.py
index 0e11e6b..2529bd9 100644 (file)
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -23,8 +23,7 @@ html_show_sphinx = False
 extensions = [
     'sphinx.ext.intersphinx',
     'sphinx.ext.graphviz',
-    'sphinxcontrib.blockdiag',
-    'sphinxcontrib.seqdiag',
+    'sphinxcontrib.mermaid',
     'sphinxcontrib.openapi',
     'sphinxcontrib.plantuml',
     'sphinx_toolbox.collapse',

diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt
index cbb8d36..9726e54 100644 (file)
--- a/docs/requirements-docs.txt
+++ b/docs/requirements-docs.txt
@@ -1,10 +1,11 @@
 sphinx>=7.1.2
 sphinx-rtd-theme>=2.0.0
-sphinxcontrib-blockdiag>=3.0.0
-sphinxcontrib-seqdiag>=3.0.0
+sphinxcontrib-mermaid>=1.0.0
 sphinxcontrib-openapi>=0.8.4
 sphinxcontrib-spelling>=8.0.0
 sphinxcontrib-plantuml>=0.27
 sphinxcontrib-redoc
 sphinx_toolbox>=3.5.0
 six
+jsonschema
+PyYAML

diff --git a/docs/tox.ini b/docs/tox.ini
index 8d9aa5c..c3c2aca 100644 (file)
--- a/docs/tox.ini
+++ b/docs/tox.ini
@@ -4,7 +4,7 @@ envlist = docs,docs-linkcheck,docs-spellcheck
 skipsdist = true
 
 [testenv:docs]
-basepython = python3.12
+basepython = python3.13
 deps =
     setuptools>=65.0.0
     -r{toxinidir}/requirements-docs.txt
@@ -17,7 +17,7 @@ allowlist_externals =
     sh
 
 [testenv:docs-linkcheck]
-basepython = python3.12
+basepython = python3.13
 deps =
     setuptools>=65.0.0
     -r{toxinidir}/requirements-docs.txt
@@ -26,7 +26,7 @@ commands =
     sphinx-build -W -q -b linkcheck -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/linkcheck
 
 [testenv:docs-spellcheck]
-basepython = python3.12
+basepython = python3.13
 deps =
     setuptools>=65.0.0
     -r{toxinidir}/requirements-docs.txt