{"id":24628,"library":"sphinxcontrib-blockdiag","title":"Sphinx blockdiag extension","description":"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.","status":"active","version":"3.0.0","language":"python","source_language":"en","source_url":"https://github.com/blockdiag/sphinxcontrib-blockdiag","tags":["sphinx","diagram","blockdiag","extension","documentation"],"install":[{"cmd":"pip install sphinxcontrib-blockdiag","lang":"bash","label":"PyPI"}],"dependencies":[{"reason":"Core diagram rendering engine for blockdiag diagrams.","package":"blockdiag","optional":false},{"reason":"Required for seqdiag directive (sequence diagrams).","package":"seqdiag","optional":true},{"reason":"Required for actdiag directive (activity diagrams).","package":"actdiag","optional":true},{"reason":"Required for nwdiag directive (network diagrams).","package":"nwdiag","optional":true}],"imports":[{"note":"setup is a module-level function; direct import of setup function needed.","wrong":"from sphinxcontrib import blockdiag","symbol":"setup","correct":"from sphinxcontrib.blockdiag import setup"}],"quickstart":{"code":"# conf.py\n\nextensions = [\n    'sphinxcontrib.blockdiag',\n]\n\n# Example RST usage:\n# .. blockdiag::\n#\n#    blockdiag {\n#      A -> B -> C;\n#    }","lang":"python","description":"Add the extension to Sphinx's conf.py extensions list. Use the 'blockdiag' directive in RST files."},"warnings":[{"fix":"Use Python 3.7+ or pin to sphinxcontrib-blockdiag==2.2.1.","message":"Version 3.0.0 removed support for Python <3.7. Upgrade your Python environment.","severity":"breaking","affected_versions":">=3.0.0, <3.0.0"},{"fix":"Install blockdiag: pip install blockdiag","message":"The extension requires the blockdiag package to be installed separately; it is not a dependency.","severity":"gotcha","affected_versions":"all"},{"fix":"Add to conf.py: blockdiag_antialias = True","message":"Output format (PNG, SVG) may need explicit configuration via blockdiag_antialias or blockdiag_compiledir settings.","severity":"gotcha","affected_versions":"all"}],"env_vars":null,"last_verified":"2026-05-01T00:00:00.000Z","next_check":"2026-07-30T00:00:00.000Z","problems":[{"fix":"Install blockdiag: pip install blockdiag","cause":"blockdiag executable not found in PATH or not installed.","error":"WARNING: blockdiag command cannot run"},{"fix":"Install the corresponding package: pip install blockdiag seqdiag actdiag nwdiag","cause":"Required diagram backend not installed.","error":"No module named 'blockdiag'"},{"fix":"Ensure the extension is listed as a string in extensions list (e.g., 'sphinxcontrib.blockdiag').","cause":"Using an outdated extension registration pattern.","error":"TypeError: setup() takes 1 positional argument but 2 were given"}],"ecosystem":"pypi","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}