From c859255e1575d1fe432d61b7409c3aa5f1d6d5d6 Mon Sep 17 00:00:00 2001 From: Matthew Watkins Date: Wed, 4 Mar 2026 16:39:48 +0000 Subject: [PATCH] Docs: Replace blockdiag/seqdiag with Mermaid MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Replace the abandoned sphinxcontrib-blockdiag and sphinxcontrib-seqdiag Sphinx extensions with sphinxcontrib-mermaid. Remove Pillow dependency which was only required for blockdiag server-side image rendering. Mermaid renders diagrams client-side via JavaScript, requiring no system packages or native image libraries. Bump basepython from python3.12 to python3.13 to match .readthedocs.yaml — blockdiag was the blocker preventing this (uses removed ast.NameConstant on 3.12+, and pkg_resources on setuptools 82+). None of the documentation in this repo uses blockdiag or seqdiag directives; this is a config-only cleanup. Issue-ID: CIMAN-33 Change-Id: Icfa7c30a05bd797cb497392dce30a8634f3f6f9f Signed-off-by: Claude Signed-off-by: Matthew Watkins --- docs/conf.py | 3 +-- docs/requirements-docs.txt | 4 +--- docs/tox.ini | 4 ++-- etc/upper-constraints.onap.txt | 4 +--- 4 files changed, 5 insertions(+), 10 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 1d9bc758..f6e9bd6a 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.openapi', 'sphinxcontrib.plantuml', ] diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt index d28f4f69..9f2bd886 100644 --- a/docs/requirements-docs.txt +++ b/docs/requirements-docs.txt @@ -1,14 +1,12 @@ # Compatibility setuptools>=65.0.0 -Pillow>=10.1.0 # Core Sphinx sphinx>=7.1.2 sphinx-rtd-theme>=2.0.0 # Diagram extensions -sphinxcontrib-blockdiag>=3.0.0 -sphinxcontrib-seqdiag>=3.0.0 +sphinxcontrib-mermaid>=1.0.0 sphinxcontrib-plantuml>=0.27 # API documentation diff --git a/docs/tox.ini b/docs/tox.ini index 714e2638..0f9eeebf 100644 --- a/docs/tox.ini +++ b/docs/tox.ini @@ -4,7 +4,7 @@ envlist = docs,docs-linkcheck skipsdist = true [testenv:docs] -basepython = python3.12 +basepython = python3.13 deps = setuptools>=65.0.0 -r{toxinidir}/requirements-docs.txt @@ -16,7 +16,7 @@ allowlist_externals = sh [testenv:docs-linkcheck] -basepython = python3.12 +basepython = python3.13 deps = setuptools>=65.0.0 -r{toxinidir}/requirements-docs.txt diff --git a/etc/upper-constraints.onap.txt b/etc/upper-constraints.onap.txt index 2be9f185..c5974b0d 100644 --- a/etc/upper-constraints.onap.txt +++ b/etc/upper-constraints.onap.txt @@ -1,14 +1,12 @@ # Compatibility setuptools===69.0.3 -Pillow===10.4.0 # Core Sphinx sphinx===7.1.2 sphinx-rtd-theme===2.0.0 # Diagram extensions -sphinxcontrib-blockdiag===3.0.0 -sphinxcontrib-seqdiag===3.0.0 +sphinxcontrib-mermaid===2.0.0 sphinxcontrib-plantuml===0.29 # API documentation -- 2.16.6