.. highlight:: rest

sphinx.ext.graphviz – Graphvizのグラフを追加

バージョン 0.6 で追加.

この拡張モジュールを使用すると、 Graphviz のグラフをドキュメント内に埋め込むことができるようになります。

この拡張モジュールは以下のディレクティブを提供します:

.. graphviz::

Graphvizのコードをドキュメント内に直接記述するためのディレクティブです。 ここでコンテンツとして入力された内容は、 dot コマンドで処理されます。

サンプル:

.. graphviz::

   digraph foo {
      "bar" -> "baz";
   }

HTML出力されるときには、PNG画像としてレンダリングされます。 LaTeX出力時にはこのコードは埋め込み可能なPDFファイルとしてレンダリングされます。

.. graph::

無向グラフをひとつ埋め込むのに使用するディレクティブです。 グラフの名前はディレクティブ引数として渡します。ディレクティブのコンテンツがそのままグラフ作成に使用されます。 このディレクティブは graph <名前> { <コンテンツ> } というグラフを作成するための便利機能です。

サンプル:

.. graph:: foo

   "bar" -- "baz";

.. digraph::

有向グラフをひとつ埋め込むために使用するディレクティブです。 グラフの名前はディレクティブ引数として渡します。ディレクティブのコンテンツがそのままグラフ作成に使用されます。 このディレクティブは digraph <名前> { <コンテンツ> } というグラフを作成するための便利機能です。

サンプル:

.. digraph:: foo

   "bar" -> "baz" -> "quux";

専用の設定もいくつか追加されます:

graphviz_dot

dot を呼び出すときに使用するコマンド名です。デフォルトでは 'dot' です。 もしも dot コマンドが実行時の検索パスに存在していなくて、フルパスを設定する必要がある場合にはこの設定値を変更してください。

この設定はシステム間では移植可能ではありません。通常の場合は conf.py で指定してしまうのは便利とはいえないでしょう。 sphinx-build コマンドを実行するときに、コマンドラインで -D オプションを指定する方が望ましいです:

sphinx-build -b html -D graphviz_dot=C:\graphviz\bin\dot.exe . _build/html

graphviz_dot_args

dot コマンドに渡す、追加のコマンドライン引数です。デフォルト値は空のリストです。 -G, -N, -E オプションを使用して、ドキュメント内のすべてのGraphvizのグラフの、グラフ、ノード、エッジの属性を変更する場合にはこのオプションを使用してください。