matplotlib.sphinxext.roles#

Matplotlib 文档的自定义角色。

警告

这些角色被视为半公开的。它们仅用于 Matplotlib 文档中。

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

Matplotlib 文档字符串可以通过两种方式出现在下游文档中。你需要继承一个 Matplotlib 类，并在你的 autodoc 配置中使用 :inherited-members: 选项，或者你必须覆盖一个方法而不指定新的文档字符串；新方法将继承原始文档字符串，并且仍然会在你的 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)[源代码][源代码]#

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

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

当前支持的值：

  • :mpltype:`color` 将呈现为: color

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

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

用法：将所需的 rcParams 键作为参数传递。

:rc:`figure.dpi` 将呈现为: rcParams["figure.dpi"] (default: 100.0)

On this page