sphinxcontrib-mermaid(3) on Linux
The text 1b160bcfe89d, as Debian 13 (Trixie) shipped it. The page shows this text now.
sphinxcontrib-mermaid documentation ATTENTION: ---- This extension allows you to embed Mermaid graphs in your documents, including general flowcharts, sequence diagrams, gantt diagrams and more. It adds a directive to embed mermaid markup. For example: By default, the HTML builder will simply render this as a div tag with class="mermaid", injecting the external javascript, css and initialization code to make mermaid works. For other builders (or if mermaid_output_format config variable is set differently), the extension will use mermaid-cli to render as to a PNG or SVG image, and then used in the proper code. [graph] You can also embed external mermaid files, by giving the file name as an argument to the directive and no additional content: As for all file references in Sphinx, if the filename is not absolute, it is taken as relative to the source directory. In addition, you can use mermaid to automatically generate a diagram to show the class inheritance using the directive autoclasstree. It accepts one or more fully qualified names to a class or a module. In the case of a module, all the class found will be included. Of course, these objects need to be importable to make its diagram. If an optional attribute :full: is given, it will show the complete hierarchy of each class. The option :namespace: <value> limits to the base classes that belongs to this namespace. Meanwhile, the flag :strict: only process the classes that are strictly defined in the given module (ignoring classes imported from other modules). For example: [graph] Or directly the module: [graph].SH INSTALLATION You can install it using pip Then add sphinxcontrib.mermaid in extensions list of your project's conf.py: