From: Matthew Watkins Date: Wed, 4 Mar 2026 17:00:19 +0000 (+0000) Subject: Docs: Add sphinxcontrib-mermaid for diagram migration X-Git-Url: https://gerrit.onap.org/r/gitweb?a=commitdiff_plain;h=7ccd7e2363f9fdca60cdc0bec7e089096c0eafee;p=sdc.git 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: Ibc24e29d11d611c1e29a3e783c483a2667edf42a Signed-off-by: Claude Signed-off-by: Matthew Watkins --- diff --git a/docs/conf.py b/docs/conf.py index 51a7266dc8..b3b7a1273a 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -19,7 +19,8 @@ html_show_sphinx = False extensions = [ 'sphinx.ext.intersphinx', 'sphinx.ext.graphviz', - 'sphinxcontrib.plantuml' + 'sphinxcontrib.mermaid', + 'sphinxcontrib.plantuml', ] # diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt index 16c646b042..6826073be7 100644 --- a/docs/requirements-docs.txt +++ b/docs/requirements-docs.txt @@ -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 diff --git a/docs/tox.ini b/docs/tox.ini index 66b85c8d46..c8841a64ab 100644 --- a/docs/tox.ini +++ b/docs/tox.ini @@ -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