🧜‍♀️

Sphinx で Mermaid を利用する

2023/01/25に公開

ドキュメントツール Sphinx でシーケンス図を作成するのに Mermaid へ切り替えたのでまとめておきます。

seqdiag

今まで Sphinx では seqdiag という Sphinx 開発者の小宮氏が開発しているツールを採用していました。

ただこれはフォントが必要だったり、メンテナンスが大変なことがあり、色々難しいなと感じていました。
特に日本語を表示する際にキレイに表示するというのが作者に相談が必要なのはちょっとコストが高すぎました。

Mermaid

そこで目を付けたのが Mermaid です。Mermaid は GitHub でも採用されており、とても有名です。
日本語もキレイに表示されます。

使いやすいライブエディターがあるのもとても良いです。
https://mermaid.live/

Sphinx で Mermaid を利用する拡張があり、 pip install するだけでインストールできます。
mgaitan/sphinxcontrib-mermaid: Mermaid diagrams in yours sphinx powered docs

拡張の追加も簡単です。

extensions = [
    ...,
    'sphinxcontrib.mermaid'
]

適用事例

https://sora-js-sdk.shiguredo.jp/callback#1ce24f

Image from Gyazo

Discussion

ログインするとコメントできます