API Reference¶

Config reference¶

Generated from add_config_value() registrations in sphinx_gp_mermaid/__init__.py.

mermaid_cmd ¶ config env config env mermaid_cmd ¶

Type:: str
Default:: ''
Registered by:: sphinx_gp_mermaid.setup()

mermaid_puppeteer_config ¶ config env config env mermaid_puppeteer_config ¶

Type:: str
Default:: ''
Registered by:: sphinx_gp_mermaid.setup()

Directive reference¶

Generated from add_directive() registrations in sphinx_gp_mermaid/__init__.py.

.. mermaid:: ¶ directive directive .. mermaid:: ¶

Stash a mermaid fence’s source on a node for the write phase to render.

Options:

Python path:: sphinx_gp_mermaid.MermaidDirective
Required arguments:: 0
Optional arguments:: 0
Final argument whitespace:: False
Has content:: True

:alt: ¶ option option :alt: ¶: Validator: unchanged.

:caption: ¶ option option :caption: ¶: Validator: unchanged.

:class: ¶ option option :class: ¶: Validator: class_option.

:name: ¶ option option :name: ¶: Validator: unchanged.

:responsive: ¶ option option :responsive: ¶: Validator: _responsive_policy.

Extension entry point¶

sphinx_gp_mermaid.setup(app) ¶ function[source] function[source] sphinx_gp_mermaid.setup(app) ¶

Register the directive, node, config values, and stylesheet.

Parameters:: app (Sphinx) – Sphinx application instance.
Returns:: Extension metadata with version and parallel-build flags.
Return type:: ExtensionMetadata

Examples

>>> from sphinx_gp_mermaid import setup
>>> callable(setup)
True