From 46dc51f091709257e8234a9ddb93485084a1ee20 Mon Sep 17 00:00:00 2001 From: Matthew Watkins Date: Wed, 4 Mar 2026 16:59:16 +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: I3750ca515e6aee47f52da2924b4cf760490d0f15 Signed-off-by: Claude Signed-off-by: Matthew Watkins --- docs/conf.py | 3 +-- docs/release-notes.rst | 2 +- docs/requirements-docs.txt | 6 +----- docs/tox.ini | 9 +++------ 4 files changed, 6 insertions(+), 14 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index f7c0ae8..18a3cdd 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/release-notes.rst b/docs/release-notes.rst index dcaa4af..4e6925d 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -368,7 +368,7 @@ Casablanca **Known Issues** - `LOG-913 `__ POMBA: 1 of 11 pods failing on sequenced startup on 3.0.0-ONAP - pomba is 22 on the order - looks timing related - - `LOG-950 `__ LOG-950 upped the numbers from 10 to 30 - for intermittent deploy timing - this is an issue for several projects since 3.0.0-ONAP - the solution is a sequenced 5h deploy via `cd.sh `__ and/or better vms for now until the `dependencies `__ and jobs are refactored into helm hooks + - `LOG-950 `__ LOG-950 upped the numbers from 10 to 30 - for intermittent deploy timing - this is an issue for several projects since 3.0.0-ONAP - the solution is a sequenced 5h deploy via `cd.sh `__ and/or better vms for now until the `dependencies `__ and jobs are refactored into helm hooks **Security Notes** - all three nodeports for kibana, context builder and data-router are open by default for now diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt index 8a03c54..bf63825 100644 --- a/docs/requirements-docs.txt +++ b/docs/requirements-docs.txt @@ -5,10 +5,6 @@ docutils setuptools six sphinx_rtd_theme>=1.0.0 -sphinxcontrib-blockdiag -sphinxcontrib-needs>=0.2.3 -sphinxcontrib-nwdiag -sphinxcontrib-seqdiag +sphinxcontrib-mermaid>=1.0.0 sphinxcontrib-plantuml -sphinx_bootstrap_theme lfdocs-conf diff --git a/docs/tox.ini b/docs/tox.ini index 46075fa..d215fd9 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 -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://releases.openstack.org/constraints/upper/yoga -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://releases.openstack.org/constraints/upper/yoga -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=master commands = sphinx-build -W -q -b spelling -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/spellcheck -- 2.16.6