sphinx.ext.inheritance_diagram – 継承関係図の追加

バージョン 0.6 で追加.

この拡張機能を使うと、継承関係図をドキュメントに挿入できます。図は、 Graphviz拡張 を使ってレンダリングされます。

この拡張機能は次のディレクティブを追加します。

.. inheritance-diagram::

このディレクティブは1つ以上の引数を持ちます。モジュールかクラス名を与えます。現在説明中のモジュールの中であれば(py:module 参照)、クラス名の名前には完全修飾名以外も使えます。

与えられたクラス、もしくは与えられたモジュールに含まれるクラスごとに、ベースクラスが決定され、すべてのクラスから、有向性グラフとして、graphviz拡張を利用して図がレンダリングされます。

このディレクティブは parts というオプションを指定しています。これには整数を指定します。もしこれが与えられると、表示名から、モジュール名にあたる部分が削除されます。例えば、もしすべてのクラスの名前が lib. で始まっている場合に、 :parts: 1 を指定すると、それぞれの表示名から lib. という文字が表示されなくなります。

これは private-bases フラグオプションも持っています。このフラグが与えられると、名前が _ から始まる、プライベートなベースクラスも含むようになります。

You can use caption option to give a caption to the diagram.

バージョン 1.1 で変更: private-bases オプションを追加しました。以前は常に全てのベースクラスが含まれていました。

バージョン 1.5 で変更: Added caption option

新しい設定値も追加されます。

inheritance_graph_attrs

継承関係図を出力する際の、graphvizのgraphの属性の辞書です。

例えば:

inheritance_graph_attrs = dict(rankdir="LR", size='"6.0, 8.0"',
                               fontsize=14, ratio='compress')
inheritance_node_attrs

継承関係図を出力する際の、graphvizのnodeの属性の辞書です。

例えば:

inheritance_node_attrs = dict(shape='ellipse', fontsize=14, height=0.75,
                              color='dodgerblue1', style='filled')
inheritance_edge_attrs

継承関係図を出力する際の、graphvizのedgeの属性の辞書です。