Docs: Add sphinxcontrib-mermaid for diagram migration 80/143480/2
authorMatthew Watkins <mwatkins@linuxfoundation.org>
Wed, 4 Mar 2026 17:00:19 +0000 (17:00 +0000)
committerMatthew Watkins <mwatkins@linuxfoundation.org>
Wed, 4 Mar 2026 17:41:00 +0000 (17:41 +0000)
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: Ibc24e29d11d611c1e29a3e783c483a2667edf42a
Signed-off-by: Claude <noreply@anthropic.com>
Signed-off-by: Matthew Watkins <mwatkins@linuxfoundation.org>
docs/conf.py
docs/requirements-docs.txt
docs/tox.ini

index 51a7266..b3b7a12 100644 (file)
@@ -19,7 +19,8 @@ html_show_sphinx = False
 extensions = [
     'sphinx.ext.intersphinx',
     'sphinx.ext.graphviz',
-    'sphinxcontrib.plantuml'
+    'sphinxcontrib.mermaid',
+    'sphinxcontrib.plantuml',
 ]
 
 #
index 16c646b..6826073 100644 (file)
@@ -2,3 +2,4 @@ sphinx>=4.2.0  # BSD
 sphinx-rtd-theme>=1.0.0  # MIT
 sphinxcontrib-spelling
 sphinxcontrib-plantuml
+sphinxcontrib-mermaid>=1.0.0
index 66b85c8..c8841a6 100644 (file)
@@ -4,7 +4,7 @@ envlist = docs,docs-linkcheck,docs-spellcheck
 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?h=master
@@ -12,14 +12,14 @@ commands =
     sphinx-build -W -q -b html -n -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/html
 
 [testenv:docs-linkcheck]
-basepython = python3.8
+basepython = python3.13
 deps =
     -r{toxinidir}/requirements-docs.txt
     -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=master
 commands =
     sphinx-build -W -q -b linkcheck -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/linkcheck
 [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?h=master