{"id":46422,"library":"sphinx-diagrams","title":"sphinx-diagrams","description":"A Sphinx extension that renders diagrams using the Diagrams library, allowing you to define cloud system architecture diagrams as Python code within your documentation. Current version: 0.4.0, released February 2020. The project appears to be in maintenance mode with no recent updates.","status":"maintenance","version":"0.4.0","language":"python","source_language":"en","source_url":"https://github.com/j-martin/sphinx-diagrams","tags":["sphinx","diagrams","documentation"],"install":[{"cmd":"pip install sphinx-diagrams","lang":"bash","label":"Install sphinx-diagrams from PyPI"},{"cmd":"pip install diagrams","lang":"bash","label":"Install the underlying Diagrams library (required)"}],"dependencies":[{"reason":"Core dependency: Sphinx extension","package":"sphinx","optional":false},{"reason":"Required for rendering diagrams","package":"diagrams","optional":false}],"imports":[{"wrong":"from sphinx_diagrams import SphinxDiagrams","symbol":"SphinxDiagrams","correct":"from sphinx_diagrams import SphinxDiagrams"}],"quickstart":{"code":"# In conf.py:\nextensions = ['sphinx_diagrams']\n\n# In your .rst file:\n.. diagram::\n\n   from diagrams import Diagram\n   from diagrams.aws.compute import EC2\n   from diagrams.aws.database import RDS\n\n   with Diagram(\"Web Service\", show=False):\n       EC2(\"web\") >> RDS(\"userdb\")","lang":"python","description":"Enable the extension in Sphinx's conf.py and use the diagram directive in reStructuredText."},"warnings":[{"fix":"Use consistent indentation (usually 4 spaces) inside the diagram directive.","message":"Node indices in diagram directive must be valid Python. Ensure correct indentation inside the with block.","severity":"gotcha","affected_versions":"all"},{"fix":"Add show=False to Diagram() constructor.","message":"The show=False parameter is recommended to avoid preview windows during documentation build on headless servers.","severity":"gotcha","affected_versions":"all"},{"fix":"Pin diagrams library version or check compatibility before upgrade.","message":"sphinx-diagrams 0.4.0 may not be actively maintained; it relies on the diagrams library which may have breaking changes.","severity":"deprecated","affected_versions":"0.4.0"}],"env_vars":null,"search_vec":"'0.4.0':30 '2020':33 'allow':14 'appear':36 'architectur':20 'cloud':18 'code':24 'current':28 'defin':17 'diagram':3,9,12,21,47 'document':27,48 'extens':6 'februari':32 'librari':13 'mainten':40 'mode':41 'project':35 'python':23 'recent':44 'releas':31 'render':8 'sphinx':2,5,46 'sphinx-diagram':1 'system':19 'updat':45 'use':10 'version':29 'within':25","created_at":"2026-06-07T12:59:51.301109+00:00","updated_at":"2026-06-07T12:59:51.301109+00:00","problems":{"verify_error":"Traceback (most recent call last):\n  File \"<string>\", line 1, in <module>\n  File \"/tmp/tmpboi7_8m_/venv/lib/python3.12/site-packages/sphinx_diagrams/__init__.py\", line 1, in <module>\n    from .sphinx_diagrams import *\n  File \"/tmp/tmpboi7_8m_/venv/lib/python3.12/site-packages/sphinx_diagrams/sphinx_"},"ecosystem":"pypi","meta_description":null,"install_score":null,"quickstart_score":null,"quickstart_tag":null,"pypi_latest":null,"cli_name":null,"cli_version":null,"type":"library","homepage":"https://github.com/j-martin/sphinx-diagrams","github":"https://github.com/j-martin/sphinx-diagrams","docs":null,"changelog":null,"pypi":null,"npm":null,"openapi_spec":null,"status_page":null,"smithery":null,"categories":["devops"],"base_url":null,"auth_type":null,"provenance":{"verified_status":"import_fail","verified_at":"2026-07-03","last_verified":"2026-07-03","next_check":"2026-07-10","install_tag":null}}