Open5

Sphinx + Seqdiag + Netlify メモ

SphinxSeqdiag を利用したドキュメントを Netlify を利用して運用するときの自分なりのメモ。

Sphinx と Seqdiag を Netlify で利用する

ポイントはフォントを準備する必要がある。SVG を利用する場合でも位置決めのためにフォントが必要。

以下の記事を seqdiag に変更すれば動く。フォントもそのままで問題ない。

https://blog.interstellar.co.jp/2019/04/sphinx-blockdiag-netlify-japanese-font/
# Fontpath for seqdiag (truetype font)
seqdiag_fontpath = os.path.join(os.path.abspath('.'), 'fonts/RictyDiminished-Regular.ttf')

seqdiag で SVG 出力にする

conf.py に以下を指定すれば良い。

seqdiag_html_image_format = "SVG"

ref と doc は積極的に使う

  • :ref:
    • .. _abc-efg: といった感じでリンクターゲットを用意してバンバン飛ばす
  • :doc:
ログインするとコメントできます