Registry / devops / sphinxcontrib-blockdiag

sphinxcontrib-blockdiag

JSON →
library3.0.0pypypiunverified

A Sphinx extension that integrates blockdiag, seqdiag, actdiag, and nwdiag diagram generation into documentation. Current version 3.0.0; supports Python >=3.7. Release cadence is irregular.

devops
pip install sphinxcontrib-blockdiag
github ↗package ↗
INSTALL
IMPORT
SIG · SPHINXCONTRIB-BLOC
S
sphinxcontrib-blockdiag
devopspythonv3.0.0
Install
6.5s avg
Import
695ms
Disk
124MB
Pass rate
10/ 10
Env Coverage10 / 10
glibc
3.9–3.13
musl
3.9–3.13
Install & Compatibility
Where this runs
tested against v3.0.0 · pip install
no network on importno background threads
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
musl
py 3.10–3.95 runs
installs and imports cleanly · install 0.0s · import 0.434s · 117.9MB
glibc
py 3.10–3.95 runs
installs and imports cleanly · install 6.5s · import 0.400s · 119MB
124MB installed
● package 124MB
Code
Verified usage

Verified import paths — ran on the pinned version, not inferred.

setup
✓ from sphinxcontrib.blockdiag import setup
✗ from sphinxcontrib.blockdiag import setup

Add the extension to Sphinx's conf.py extensions list. Use the 'blockdiag' directive in RST files.

# conf.py extensions = [ 'sphinxcontrib.blockdiag', ] # Example RST usage: # .. blockdiag:: # # blockdiag { # A -> B -> C; # }
Debug
Known issues
breakingVersion 3.0.0 removed support for Python <3.7. Upgrade your Python environment.
fix
Use Python 3.7+ or pin to sphinxcontrib-blockdiag==2.2.1.
affects: >=3.0.0, <3.0.0
gotchaThe extension requires the blockdiag package to be installed separately; it is not a dependency.
fix
Install blockdiag: pip install blockdiag
affects: all
gotchaOutput format (PNG, SVG) may need explicit configuration via blockdiag_antialias or blockdiag_compiledir settings.
fix
Add to conf.py: blockdiag_antialias = True
affects: all
Upgrade
Version history
3.0.0latest on PyPI · released Dec 5, 2021
Audit
Dependencies
blockdiagrequiredCore diagram rendering engine for blockdiag diagrams.
seqdiagoptionalRequired for seqdiag directive (sequence diagrams).
actdiagoptionalRequired for actdiag directive (activity diagrams).
nwdiagoptionalRequired for nwdiag directive (network diagrams).
Agent activity
6 hits · last 30 days
node
6
Resources
githubhttps://github.com/blockdiag/sphinxcontrib-blockdiag ↗
packagehttps://pypi.org/project/sphinxcontrib-blockdiag/ ↗
sphinxcontrib-blockdiag — pip install sphinxcontrib-blockdiag · libregistry