sphinx-gp-mermaid

Build-time Mermaid diagrams for Sphinx. Fenced mermaid blocks render to inline <svg> during the build via mmdc (@mermaid-js/mermaid-cli): no client-side mermaid runtime, no asynchronous pop-in, no layout shift.

Each diagram is rendered twice — a light and a dark variant — and both are inlined, toggled by CSS on body[data-theme]. Diagrams paint with the page, follow the theme toggle without JavaScript, and survive SPA navigation as live DOM.

Install

$ pip install sphinx-gp-mermaid

Usage

Enable the extension in conf.py:

extensions = ["sphinx_gp_mermaid"]

With gp-sphinx, opt in via merge_sphinx_config:

config = merge_sphinx_config(
    extra_extensions=["sphinx_gp_mermaid"],
)

Author diagrams as MyST fences:

:::{mermaid}
:caption: How it flows.
:alt: a request flowing through two steps
:name: request-flow
:responsive: fit

flowchart LR
    a --> b
:::

fit is the default responsive policy: the rendered SVG scales down to the content column. Use :responsive: preserve when a dense diagram should keep its intrinsic width and scroll horizontally instead of shrinking labels.

Renderer toolchain

Rendering shells out to mmdc, resolved from the mermaid_cmd config value, then <confdir>/node_modules/.bin/mmdc, then PATH. Install it in the docs toolchain:

$ pnpm add -D @mermaid-js/mermaid-cli

When the renderer is unavailable the build still succeeds: diagrams degrade to their source text with a single warning.

Documentation

See the full documentation for directive options, theming, caching, and CI setup.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinx_gp_mermaid-0.0.1a36.tar.gz (71.3 kB view details)

Uploaded Jul 26, 2026 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

sphinx_gp_mermaid-0.0.1a36-py3-none-any.whl (12.8 kB view details)

Uploaded Jul 26, 2026 Python 3

File details

Details for the file sphinx_gp_mermaid-0.0.1a36.tar.gz.

File metadata

Download URL: sphinx_gp_mermaid-0.0.1a36.tar.gz
Upload date: Jul 26, 2026
Size: 71.3 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for sphinx_gp_mermaid-0.0.1a36.tar.gz
Algorithm	Hash digest
SHA256	`a939563f8e4fc6c4ae0191b46ef07176ffc00a8cbda562c80c76015d9750622f`
MD5	`9a7413ebf82062e27d39126c5d57fabd`
BLAKE2b-256	`25eaab72835ca7fe0d96fdf1692c9cbe3e275394a45c997ae1a67140485c06cb`

See more details on using hashes here.

Provenance

The following attestation bundles were made for sphinx_gp_mermaid-0.0.1a36.tar.gz:

Publisher: release.yml on git-pull/gp-sphinx

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: sphinx_gp_mermaid-0.0.1a36.tar.gz
- Subject digest: a939563f8e4fc6c4ae0191b46ef07176ffc00a8cbda562c80c76015d9750622f
- Sigstore transparency entry: 2255932148
- Sigstore integration time: Jul 26, 2026
Source repository:
- Permalink: git-pull/gp-sphinx@5f287dfe1d7e138f75a9f2622be5a287a868f5b5
- Branch / Tag: refs/tags/v0.0.1a36
- Owner: https://github.com/git-pull
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: release.yml@5f287dfe1d7e138f75a9f2622be5a287a868f5b5
- Trigger Event: push