From: Matthew Watkins Date: Wed, 4 Mar 2026 16:59:21 +0000 (+0000) Subject: Docs: Replace blockdiag/seqdiag with Mermaid X-Git-Url: https://gerrit.onap.org/r/gitweb?a=commitdiff_plain;ds=inline;p=multicloud%2Fk8s.git 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: Ia83c8cb62fd5e00632409587bbb97c7430f28108 Signed-off-by: Claude Signed-off-by: Matthew Watkins --- diff --git a/docs/conf.py b/docs/conf.py index f7c0ae8f..18a3cdd4 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 d5356775..822b0407 100644 --- a/docs/tox.ini +++ b/docs/tox.ini @@ -3,21 +3,21 @@ minversion = 1.6 envlist = docs,docs-linkcheck,docs-spellcheck skipsdist = true [testenv:docs] -#basepython = python3.10 +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 html -n -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/html [testenv:docs-linkcheck] -#basepython = python3.10 +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.10 +basepython = python3.13 deps = -r{toxinidir}/requirements-docs.txt -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=master diff --git a/tox.ini b/tox.ini index 65e0258e..b5a1333f 100644 --- a/tox.ini +++ b/tox.ini @@ -42,6 +42,5 @@ commands = bash -c "find {toxinidir} -not -path {toxinidir}/.tox/\* \ [testenv:docs] deps = -r{toxinidir}/docs/requirements-docs.txt - -chttps://git.onap.org/doc/plain/etc/upper-constraints.os.txt -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt commands = sphinx-build -W -b html docs docs/build/html \ No newline at end of file