Docs: Add sphinxcontrib-mermaid for diagram migration

Add sphinxcontrib-mermaid alongside existing blockdiag/seqdiag
extensions to prepare for migrating live diagrams from blockdiag
to Mermaid syntax.

The blockdiag/seqdiag extensions are abandoned and incompatible
with modern Python. The live diagram content in this repository
will be migrated to Mermaid syntax in a follow-up change, after
which blockdiag/seqdiag can be removed.

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

diff --git a/docs/conf.py b/docs/conf.py
index 754d827..adb7544 100644 (file)
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -20,6 +20,7 @@ extensions = [
     'sphinx.ext.intersphinx',
     'sphinx.ext.graphviz',
     'sphinxcontrib.blockdiag',
+    'sphinxcontrib.mermaid',
     'sphinxcontrib.seqdiag',
     'sphinxcontrib.swaggerdoc',  # TODO: Remove in separate change (unmaintained)
     'sphinxcontrib.plantuml',

diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt
index 97f7785..6bc6060 100644 (file)
--- a/docs/requirements-docs.txt
+++ b/docs/requirements-docs.txt
@@ -2,6 +2,7 @@ sphinx>=4.2.0  # BSD
 sphinx-rtd-theme>=1.0.0  # MIT
 Pillow # Diagram extensions (not compatible with Pillow>=10)
 sphinxcontrib-blockdiag  # BSD
+sphinxcontrib-mermaid>=1.0.0
 sphinxcontrib-seqdiag # BSD
 sphinxcontrib-openapi
 sphinxcontrib-swaggerdoc  # TODO: Remove in separate change (unmaintained)

diff --git a/docs/tox.ini b/docs/tox.ini
index 673011c..fe3ee9d 100644 (file)
--- a/docs/tox.ini
+++ b/docs/tox.ini
@@ -4,7 +4,7 @@ envlist = docs,
 skipsdist = true
 
 [testenv:docs]
-basepython = python3.8
+basepython = python3.13
 deps =
     -r{toxinidir}/requirements-docs.txt
     -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt
@@ -18,14 +18,14 @@ allowlist_externals =
     sh
 
 [testenv:docs-linkcheck]
-basepython = python3.8
+basepython = python3.13
 #deps = -r{toxinidir}/requirements-docs.txt
 commands = echo "Link Checking not enforced"
 #commands = sphinx-build -W -b linkcheck -d {envtmpdir}/doctrees ./ {toxinidir}/_build/linkcheck
 allowlist_externals = echo
 
 [testenv:docs-spellcheck]
-basepython = python3.8
+basepython = python3.13
 deps =
     -r{toxinidir}/requirements-docs.txt
     -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt