matplotlib.sphinxext.roles#

用于 Matplotlib 文档的自定义角色。

警告

这些角色被认为是半公开的。它们仅旨在用于 Matplotlib 文档。

然而，下游软件包可能会在它们的文档中引入这些角色，这将会导致文档构建错误。以下描述了确切的机制以及如何修复这些错误。

Matplotlib 文档字符串有两种方式会出现在下游文档中。您必须子类化一个 Matplotlib 类，并使用 :inherited-members: 选项在您的 autodoc 配置中，或者您必须重写一个方法而不指定新的文档字符串；新方法将继承原始文档字符串并仍会在您的 autodoc 中渲染。如果文档字符串包含自定义 Sphinx 角色之一，您将看到以下错误消息之一

Unknown interpreted text role "mpltype".
Unknown interpreted text role "rc".

为了解决这个问题，您可以将此模块作为扩展添加到您的 Sphinx conf.py 中

extensions = [
    'matplotlib.sphinxext.roles',
    # Other extensions.
]

警告

不官方支持在其他软件包中直接使用这些角色。我们保留修改或删除这些角色而恕不另行通知的权利。

matplotlib.sphinxext.roles._mpltype_role(name, rawtext, text, lineno, inliner, options=None, content=None)[source]#

Sphinx 角色 :mpltype: 用于自定义 Matplotlib 类型。

在 Matplotlib 中，有许多类似类型的概念没有直接的类型表示；例如：颜色。此角色允许在文档中正确突出显示它们并链接到它们的定义。

当前支持的值

  • :mpltype:`color` 将显示为: color

matplotlib.sphinxext.roles._rcparam_role(name, rawtext, text, lineno, inliner, options=None, content=None)[source]#

Sphinx 角色 :rc: 用于突出显示并链接 rcParams 条目。

用法：将所需的 rcParams 键作为参数给出。

:rc:`figure.dpi` 将显示为: rcParams["figure.dpi"] (默认值: 100.0)

在此页