Skip to content

Commit bb1a682

Browse files
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: I77f7ff0094060d6a85851de94b6e32f5519e5667 Signed-off-by: Claude <noreply@anthropic.com> Signed-off-by: Matthew Watkins <mwatkins@linuxfoundation.org>
1 parent 24ac65d commit bb1a682

File tree

3 files changed

+5
-10
lines changed

3 files changed

+5
-10
lines changed

docs/conf.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,7 @@
1919
extensions = [
2020
'sphinx.ext.intersphinx',
2121
'sphinx.ext.graphviz',
22-
'sphinxcontrib.blockdiag',
23-
'sphinxcontrib.seqdiag',
22+
'sphinxcontrib.mermaid',
2423
'sphinxcontrib.plantuml'
2524
]
2625

docs/requirements-docs.txt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
six
22
sphinx>=4.2.0 # BSD
33
sphinx-rtd-theme>=1.0.0 # MIT
4-
sphinxcontrib-blockdiag # BSD
5-
sphinxcontrib-seqdiag # BSD
4+
sphinxcontrib-mermaid>=1.0.0
65
sphinxcontrib-spelling
76
sphinxcontrib-plantuml
87
six

docs/tox.ini

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,28 +4,25 @@ envlist = docs,docs-linkcheck,docs-spellcheck
44
skipsdist = true
55

66
[testenv:docs]
7-
basepython = python3.8
7+
basepython = python3.13
88
deps =
99
-r{toxinidir}/requirements-docs.txt
10-
-chttps://releases.openstack.org/constraints/upper/yoga
1110
-chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=master
1211
commands =
1312
sphinx-build -W -q -b html -n -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/html
1413

1514
[testenv:docs-linkcheck]
16-
basepython = python3.8
15+
basepython = python3.13
1716
deps =
1817
-r{toxinidir}/requirements-docs.txt
19-
-chttps://releases.openstack.org/constraints/upper/yoga
2018
-chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=master
2119
commands =
2220
sphinx-build -W -q -b linkcheck -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/linkcheck
2321

2422
[testenv:docs-spellcheck]
25-
basepython = python3.8
23+
basepython = python3.13
2624
deps =
2725
-r{toxinidir}/requirements-docs.txt
28-
-chttps://releases.openstack.org/constraints/upper/yoga
2926
-chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=master
3027
commands =
3128
sphinx-build -W -q -b spelling -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/spellcheck

0 commit comments

Comments
 (0)