`sphinx.ext.graphviz` --Graphvizグラフの追加¶

バージョン 0.6 で追加.

この拡張により、埋め込みが可能になります Graphviz 文書中のグラフです

これは以下の指示を追加する：

.. graphviz::¶

コマンドは図形コードを埋め込む.の入力コード dot 内容として与えられています。例えば：

.. graphviz::

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

HTML出力では、コードはPNGまたはSVG画像として表示される(参照 graphviz_output_format ）。LaTeX出力では、コードは埋め込み可能なPDFファイルとして提示される。

外部ポイントファイルを埋め込むことも可能であり，ファイル名をパラメータとして指定する方法である. graphviz 他にはありません

.. graphviz:: external.dot

Sphinx内のすべてのファイル参照について、ファイル名が絶対である場合、ソースディレクトリに対するものとする。

バージョン 1.1 で変更: 外部ファイルへのサポートを追加しました。

オプション

:alt: alternate text (text)¶: 図形の代替テキスト。デフォルトの場合、図形コードはテキストを置き換えるために使用されます。

バージョン 1.0 で追加.

:align: alignment of the graph (left, center or right)¶: 図形の水平整列方式。

バージョン 1.5 で追加.

:caption: caption of the graph (text)¶: グラフのタイトル。

バージョン 1.1 で追加.

:layout: layout type of the graph (text)¶: The layout of the graph (ex. dot, neato and so on). A path to the graphviz commands are also allowed. By default, graphviz_dot is used.

バージョン 1.4 で追加.

バージョン 2.2 で変更: 名前を立て直す graphviz_dot

:name: label (text)¶: グラフのラベルです。

バージョン 1.6 で追加.

:class: class names (a list of class names separeted by spaces)¶: 図形のクラス名。

バージョン 2.4 で追加.

.. graph::¶

単一の無向グラフを埋め込むための命令。名前は命令パラメータとして与えられ，図形の内容は命令内容である.これは生成しやすい指示です graph <name> {{ <content> }} それがそうです。

例えば：

.. graph:: foo

   "bar" -- "baz";

注釈

図形名はそのままGraphvizに渡される.それが非英数字文字(例えば、破折番号)を含む場合、それは二重引用符で導かれなければならない。

オプション

相同 graphviz それがそうです。

:alt: alternate text (text)¶: バージョン 1.0 で追加.

:align: alignment of the graph (left, center or right)¶: バージョン 1.5 で追加.

:caption: caption of the graph (text)¶: バージョン 1.1 で追加.

:layout: layout type of the graph (text)¶: バージョン 1.4 で追加.

バージョン 2.2 で変更: 名前を立て直す graphviz_dot

:name: label (text)¶: バージョン 1.6 で追加.

:class: class names (a list of class names separeted by spaces)¶: 図形のクラス名。

バージョン 2.4 で追加.

.. digraph::¶

単一の有向グラフを埋め込むための命令。名前は命令パラメータとして与えられ，図形の内容は命令内容である.これは生成しやすい指示です digraph <name> {{ <content> }} それがそうです。

例えば：

.. digraph:: foo

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

オプション

相同 graphviz それがそうです。

:alt: alternate text (text)¶: バージョン 1.0 で追加.

:align: alignment of the graph (left, center or right)¶: バージョン 1.5 で追加.

:caption: caption of the graph (text)¶: バージョン 1.1 で追加.

:layout: layout type of the graph (text)¶: バージョン 1.4 で追加.

バージョン 2.2 で変更: 名前を立て直す graphviz_dot

:name: label (text)¶: バージョン 1.6 で追加.

:class: class names (a list of class names separeted by spaces)¶: 図形のクラス名。

バージョン 2.4 で追加.

また、以下の構成値があります。

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¶: Additional command-line arguments to give to dot, as a list. The default is an empty list. This is the right place to set global graph, node or edge attributes via dot's -G, -N and -E options.

graphviz_output_format¶

HTMLファイルを生成する際のGraphvizの出力フォーマット.これはきっと 'png' あるいは…。 'svg' デフォルト値は 'png' それがそうです。もし 'svg' URLリンクを正常に動作させるために、適切なものをご利用ください target 属性、例えば "_top" そして "_blank" それがそうです。例えば、次の図のリンクは、SVG出力において機能すべきである。

.. graphviz::

     digraph example {
         a [label="sphinx", href="http://sphinx-doc.org", target="_top"];
         b [label="other"];
         a -> b;
     }

バージョン 1.0 で追加: 以前、出力はいつもPNGでした。

前のトピックへ

次のトピックへ

`sphinx.ext.graphviz` --Graphvizグラフの追加¶

sphinx.ext.graphviz --Graphvizグラフの追加¶

`sphinx.ext.graphviz` --Graphvizグラフの追加¶