From 1bd08ca368dd62c86800f49634c8d382f2970b58 Mon Sep 17 00:00:00 2001 From: Matthew Watkins Date: Wed, 4 Mar 2026 16:59:19 +0000 Subject: [PATCH] Docs: Replace blockdiag/seqdiag with Mermaid Replace the abandoned sphinxcontrib-blockdiag and sphinxcontrib-seqdiag Sphinx extensions with sphinxcontrib-mermaid in docs configuration. None of the documentation in this repository uses blockdiag or seqdiag directives; this is a config-only cleanup. Issue-ID: CIMAN-33 Change-Id: I0620d6e2d0aecd7a0f9360889e4c60f0749791bf Signed-off-by: Claude Signed-off-by: Matthew Watkins --- docs/conf.py | 3 +-- docs/requirements-docs.txt | 3 +-- docs/tox.ini | 9 +++------ 3 files changed, 5 insertions(+), 10 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index f8cb3d3b..75b6bbbf 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -19,8 +19,7 @@ html_show_sphinx = False extensions = [ 'sphinx.ext.intersphinx', 'sphinx.ext.graphviz', - 'sphinxcontrib.blockdiag', - 'sphinxcontrib.seqdiag', + 'sphinxcontrib.mermaid', 'sphinxcontrib.plantuml' ] diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt index a72d6013..62bbe24f 100644 --- a/docs/requirements-docs.txt +++ b/docs/requirements-docs.txt @@ -1,7 +1,6 @@ sphinx>=4.2.0 # BSD sphinx-rtd-theme>=1.0.0 # MIT -sphinxcontrib-blockdiag # BSD -sphinxcontrib-seqdiag # BSD +sphinxcontrib-mermaid>=1.0.0 sphinxcontrib-spelling sphinxcontrib-plantuml six diff --git a/docs/tox.ini b/docs/tox.ini index 73e317e7..25c81e2c 100644 --- a/docs/tox.ini +++ b/docs/tox.ini @@ -4,28 +4,25 @@ envlist = docs,docs-linkcheck,docs-spellcheck skipsdist = true [testenv:docs] -basepython = python3.8 +basepython = python3.13 deps = -r{toxinidir}/requirements-docs.txt - -chttps://releases.openstack.org/constraints/upper/yoga -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=master commands = sphinx-build -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://releases.openstack.org/constraints/upper/yoga -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=master commands = sphinx-build -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://releases.openstack.org/constraints/upper/yoga -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=master commands = sphinx-build -q -b spelling -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/spellcheck -- 2.16.6