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: I95a576d94d14a87707f9696c8de8f2497243f501
Signed-off-by: Claude <noreply@anthropic.com>
Signed-off-by: Matthew Watkins <mwatkins@linuxfoundation.org>

diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index 3c438a0..93d6e13 100644 (file)
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -131,7 +131,6 @@ documentation:link-check:
   script:
     - . .ci/common.sh
     - pip install -r requirements.txt
-      -chttps://git.onap.org/doc/plain/etc/upper-constraints.os.txt
       -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt
     - title "Running documentation links check..."
     - exit_code=0
@@ -157,7 +156,6 @@ documentation:spelling:
     - apt-get install -qq --yes curl libenchant-2-2
     - curl -LO https://git.onap.org/doc/plain/docs/spelling_wordlist.txt
     - pip install -r requirements.txt
-      -chttps://git.onap.org/doc/plain/etc/upper-constraints.os.txt
       -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt
     - title "Running documentation spelling check..."
     - exit_code=0
@@ -256,7 +254,6 @@ documentation:
     - apt-get update
     - apt-get install --yes graphviz plantuml
     - pip install -r requirements.txt
-      -chttps://git.onap.org/doc/plain/etc/upper-constraints.os.txt
       -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt
     - title "Running documentation build..."
     - exit_code=0

diff --git a/docs/conf.py b/docs/conf.py
index a3b360b..3a7b66f 100644 (file)
--- 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',
     'sphinx_toolbox.collapse'
 ]

diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt
index 60b1780..d22f602 100644 (file)
--- a/docs/requirements-docs.txt
+++ b/docs/requirements-docs.txt
@@ -1,7 +1,6 @@
 sphinx>=7.1.2
 sphinx-rtd-theme>=2.0.0  # MIT
-sphinxcontrib-blockdiag  # BSD
-sphinxcontrib-seqdiag # BSD
+sphinxcontrib-mermaid>=1.0.0
 sphinxcontrib-spelling
 sphinxcontrib-plantuml
 sphinx_toolbox>=3.2.0

diff --git a/docs/tox.ini b/docs/tox.ini
index cdad99d..a02ff31 100644 (file)
--- a/docs/tox.ini
+++ b/docs/tox.ini
@@ -4,10 +4,9 @@ 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
 allowlist_externals = sudo
 commands =
@@ -15,10 +14,9 @@ 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
 allowlist_externals = sudo
 commands =
@@ -26,10 +24,9 @@ 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
 allowlist_externals = sudo
 commands =

diff --git a/tox.ini b/tox.ini
index 22139bc..6a540bb 100644 (file)
--- a/tox.ini
+++ b/tox.ini
@@ -12,19 +12,17 @@ skipsdist=true
 ignore-path-errors=docs/sections/resources/helm/helm-search.txt;D001
 
 [testenv:doc8]
-basepython = python3.8
+basepython = python3.10
 deps =
     -r{toxinidir}/requirements.txt
-    ; ; -chttps://releases.openstack.org/constraints/upper/yoga
     -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt
 commands =
  - doc8 docs/
 
 [testenv:docs]
-basepython = python3.8
+basepython = python3.10
 deps =
     -r{toxinidir}/requirements.txt
-    ; -chttps://releases.openstack.org/constraints/upper/yoga
     -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt
 allowlist_externals = sudo
 commands =
@@ -32,10 +30,9 @@ commands =
     sphinx-build -q -W -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
 
 [testenv:docs-linkcheck]
-basepython = python3.8
+basepython = python3.10
 deps =
     -r{toxinidir}/requirements.txt
-    ; -chttps://releases.openstack.org/constraints/upper/yoga
     -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt
 allowlist_externals = sudo
 commands =
@@ -43,13 +40,12 @@ commands =
     sphinx-build -q -W -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck
 
 [testenv:spelling]
-basepython = python3.8
+basepython = python3.10
 allowlist_externals =
     wget
     sudo
 deps =
     -r{toxinidir}/requirements.txt
-    ; -chttps://releases.openstack.org/constraints/upper/yoga
     -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt
 changedir={toxinidir}/docs
 commands =
@@ -58,10 +54,9 @@ commands =
     sphinx-build -b spelling -d {envtmpdir}/doctrees . _build/spelling
 
 [testenv:gitlint]
-basepython = python3.8
+basepython = python3.10
 deps =
     -r{toxinidir}/requirements.txt
-    ; -chttps://releases.openstack.org/constraints/upper/yoga
     -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt
 commands =
   gitlint
@@ -81,19 +76,17 @@ commands =
     find . -not -path '*/\.*' -name *.sh -exec shellcheck \{\} +
 
 [testenv:autopep8]
-basepython = python3.8
+basepython = python3.10
 deps =
     -r{toxinidir}/requirements.txt
-    ; -chttps://releases.openstack.org/constraints/upper/yoga
     -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt
 commands =
     autopep8 --max-line-length 120 --in-place --recursive kubernetes/ TOSCA/ docs/
 
 [testenv:pylint]
-basepython = python3.8
+basepython = python3.10
 deps =
     -r{toxinidir}/requirements.txt
-    ; -chttps://releases.openstack.org/constraints/upper/yoga
     -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt
 allowlist_externals = find
 commands =