`sphinx.ext.inheritance_diagram` – 包含继承图¶

在版本 0.6 中添加。

此扩展允许您包含继承图，通过 Graphviz 扩展 渲染。

它添加了以下指令

.. inheritance-diagram::¶

此指令有一个或多个参数，每个参数都给出一个模块或类名。类名可以不带限定符；在这种情况下，它们被认为存在于当前描述的模块中（参见 py:module）。

对于每个给定的类，以及每个给定模块中的每个类，都确定基类。然后，从所有类及其基类中生成一个图，该图随后通过 graphviz 扩展渲染为有向图。

此指令支持一个名为 parts 的选项，如果给出，它必须是一个整数，建议指令在显示的名称中保留那么多点分隔的部分（从右到左）。例如，parts=1 将只显示类名，不显示包含它们的模块的名称。

在版本 2.0 中更改: 的值parts 也可以是负数，表示要从左侧删除多少部分。例如，如果您的所有类名都以 lib. 开头，您可以给出 :parts: -1 以从显示的节点名称中删除该前缀。

该指令还支持一个 private-bases 标志选项；如果给出，则将包含私有基类（其名称以 _ 开头）。

您可以使用 caption 选项为图表添加标题。

在版本 1.1 中更改: 添加了 private-bases 选项；以前，所有基类始终被包含。

在版本 1.5 中更改: 添加了 caption 选项

它还支持一个 top-classes 选项，它需要一个或多个以逗号分隔的类名。如果指定，继承遍历将停止在指定的类名处。给定以下 Python 模块

"""
       A
      / \
     B   C
    / \ / \
   E   D   F
"""

class A:
    pass

class B(A):
    pass

class C(A):
    pass

class D(B, C):
    pass

class E(B):
    pass

class F(C):
    pass

如果您在继承图中指定了这样一个模块

.. inheritance-diagram:: dummy.test
   :top-classes: dummy.test.B, dummy.test.C

任何作为 top-classes 的祖先并且也在同一个模块中定义的基类将被渲染为独立节点。在此示例中，类 A 将作为独立节点渲染在图形中。由于此扩展的内部工作原理，这是一个已知问题。

如果您不想让类 A（或任何其他祖先）可见，那么只需指定您想要为其生成图表的类，如下所示

.. inheritance-diagram:: dummy.test.D dummy.test.E dummy.test.F
   :top-classes: dummy.test.B, dummy.test.C

在版本 1.7 中更改: 添加了 top-classes 选项以限制继承图的范围。

示例¶

以下是实现指令的内部 InheritanceDiagram 类的不同继承图。

使用完整名称

.. inheritance-diagram:: sphinx.ext.inheritance_diagram.InheritanceDiagram

Inheritance diagram of sphinx.ext.inheritance_diagram.InheritanceDiagram

仅显示类名

.. inheritance-diagram:: sphinx.ext.inheritance_diagram.InheritanceDiagram
   :parts: 1

在 sphinx.util.docutils.SphinxDirective（仍然是 Sphinx 部分的最高超类）处停止图表，并从所有名称中删除公共最左侧部分（sphinx）

.. inheritance-diagram:: sphinx.ext.inheritance_diagram.InheritanceDiagram
   :top-classes: sphinx.util.docutils.SphinxDirective
   :parts: -1

class sphinx.ext.inheritance_diagram.InheritanceDiagram¶: 实现 inheritance-diagram 指令的内部类。

配置¶

inheritance_graph_attrs¶

继承图的 graphviz 图表属性字典。

例如

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

inheritance_node_attrs¶

继承图的 graphviz 节点属性字典。

例如

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

inheritance_edge_attrs¶: 继承图的 graphviz 边属性字典。

inheritance_alias¶

允许将类的完整限定名映射到自定义值（当暴露类的底层路径不可取时很有用，例如，它是一个私有类，不应由用户实例化）。

例如

inheritance_alias = {'_pytest.Magic': 'pytest.Magic'}

sphinx.ext.inheritance_diagram – 包含继承图¶

示例¶

配置¶

`sphinx.ext.inheritance_diagram` – 包含继承图¶