Sphinxの拡張機能のsphinxcontrib-blockdiagを使ってみる

昨日、Sphinxblockdiagを試してみて良さげだなぁという印象を受けたのですが、 Twitter@tk0miyaさんから、Sphinx拡張機能を使えばreSTにblockdiagを埋め込めます!と。 make htmlするだけでOK。ありがたい情報でございます。   さっそくblockdiagのSphinx拡張のページをみると↓。なるほどなるほど。 http://blockdiag.com/ja/blockdiag/sphinxcontrib.html == Sphinx拡張機能として blockdiag によるブロック図を埋め込むことができます。 ブロック図の埋め込みには blockdiag ディレクティブを利用します。  ==   ということで、このページのやり方に従ってsphinxのプロジェクトにあるconf.pyに - extensionsの定義と - フォントの設定(とりあえずMSゴシック)を 入れてみます。

# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = ['sphinxcontrib.blockdiag']

# Fontpath for blockdiag (truetype font)
blockdiag_fontpath = 'C:WindowsFontsmsgothic.ttc'

  index.rstを以下のようにしてmake htmlしてみます。

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

.. blockdiag::

    site {
      hoge <- aaa;
      hoge <- bbb;
      hoge <- ccc;
      ccc <- xxx;
    }

  すると、、、↓。おぉ、コマンド一発ですね。便利。