How mgaitan/sphinxcontrib-mermaid works
sphinxcontrib-mermaid is a Sphinx extension for authoring Mermaid diagrams and class-inheritance diagrams in documentation. A document author supplies inline or external Mermaid markup, or names classes/modules for an autoclass tree; Sphinx then emits raw Mermaid for HTML or renders image output for supported builders. The extension also supports diagram options, translations, zoom and fullscreen behavior. The graph reflects the README and sampled implementation; some builder and configuration details were not included in the source excerpts.
Main entry points: __init__.py Builder output · autoclassdiag.py Class discovery · exceptions.py Mermaid errors
Components 14
Diagram authoring
- Mermaid directive
sphinxcontrib/mermaid/__init__.py - External Mermaid source
Rendering
- Builder output
sphinxcontrib/mermaid/__init__.py - Mermaid CLI
- PDF cropping
Class diagrams
- Autoclass directive
sphinxcontrib/mermaid/__init__.py - Class discovery
sphinxcontrib/mermaid/autoclassdiag.py - Mermaid errors
sphinxcontrib/mermaid/exceptions.py
HTML enhancements
- HTML assets
sphinxcontrib/mermaid/__init__.py - Mermaid JavaScript
- Zoom and fullscreen
sphinxcontrib/mermaid/__init__.py - D3 library
Other components
- Documentation author
- Sphinx build
Connections 14
- Documentation author → Mermaid directive: writes markup
README.md - Documentation author → Autoclass directive: names classes
README.md - Sphinx build → Mermaid directive: processes directive
README.md - Mermaid directive → External Mermaid source: reads source
sphinxcontrib/mermaid/__init__.py - Mermaid directive → Builder output: provides diagram
README.md - Sphinx build → Autoclass directive: processes directive
README.md - Autoclass directive → Class discovery: generates hierarchy
sphinxcontrib/mermaid/__init__.py - Class discovery → Mermaid errors: raises errors
sphinxcontrib/mermaid/autoclassdiag.py - Builder output → Mermaid CLI: renders diagrams
README.md - Builder output → PDF cropping: crops PDF
sphinxcontrib/mermaid/__init__.py - Builder output → HTML assets: emits HTML
README.md - HTML assets → Mermaid JavaScript: loads runtime
README.md - HTML assets → Zoom and fullscreen: configures features
sphinxcontrib/mermaid/__init__.py - HTML assets → D3 library: loads when configured
sphinxcontrib/mermaid/__init__.py