Skip to content

feat(docs): add sphinxcontrib-mermaid extension to Sphinx build #312

Description

@simon-d-bmw

Problem

Mermaid diagrams (```mermaid code blocks) in RST/MyST documentation sources are not rendered — the extension is missing from the Sphinx configuration and Python deps.

Proposed Change

bazel/rules/rules_score/requirements.in — add sphinxcontrib-mermaid

bazel/rules/rules_score/requirements.txt — pin with hashes:

sphinxcontrib-mermaid==2.0.0     --hash=sha256:59a73249bbee2c74b1a4db036f8e8899ade65982bdda6712cf22b4f4e9874bb5     --hash=sha256:cf4f7d453d001132eaba5d1fdf53d42049f02e913213cf8337427483bfca26f4

bazel/rules/rules_score/BUILD — add requirement("sphinxcontrib-mermaid") to the score_build py_binary deps.

bazel/rules/rules_score/templates/conf.template.py — add "sphinxcontrib.mermaid" to the extensions list.

Motivation

Mermaid is increasingly used for lightweight sequence/flow diagrams in documentation. Adding the extension enables diagram rendering without requiring PlantUML or external SVGs.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions