Docutils 标记 API¶

本节描述了用于添加 reStructuredText 标记元素（角色和指令）的 API。

角色¶

角色遵循以下描述的接口。它们必须由扩展使用 Sphinx.add_role() 或 Sphinx.add_role_to_domain() 进行注册。

def role_function(
    role_name: str, raw_source: str, text: str,
    lineno: int, inliner: Inliner,
    options: dict = {}, content: list = [],
) -> tuple[list[Node], list[system_message]]:
    elements = []
    messages = []
    return elements, messages

options 和 content 参数仅用于通过 role 指令创建的自定义角色。返回值是一个包含两个列表的元组，第一个包含角色的文本节点和元素，第二个包含生成的任何系统消息。有关更多信息，请参阅 Docutils 的自定义角色概述。

创建自定义角色¶

Sphinx 提供了两个用于创建自定义角色的基类，SphinxRole 和 ReferenceRole。

这些提供了创建角色的基于类的接口，其中主要逻辑必须在您的 run() 方法中实现。这些类提供了许多有用的方法和属性，例如 self.text、self.config 和 self.env。ReferenceRole 类实现了 Sphinx 的 title <target> 逻辑，公开了 self.target 和 self.title 属性。这对于创建交叉引用角色很有用。

指令¶

指令由派生自 docutils.parsers.rst.Directive 的类处理。它们必须由扩展使用 Sphinx.add_directive() 或 Sphinx.add_directive_to_domain() 进行注册。

class docutils.parsers.rst.Directive[source]¶

新指令的标记语法由以下五个类属性决定

required_arguments = 0¶: 所需指令参数的数量。

optional_arguments = 0¶: 所需参数后的可选参数数量。

final_argument_whitespace = False¶: 最终参数是否可以包含空格？

option_spec = None¶

选项名称到验证器函数的映射。

选项验证器函数接受一个参数，即选项参数（如果未给定则为 None），并应验证或将其转换为正确的形式。它们会引发 ValueError 或 TypeError 以指示失败。

docutils.parsers.rst.directives 模块中有几个预定义且可能非常有用的验证器。

has_content = False¶: 指令是否可以包含内容？

新指令必须实现 run() 方法

run()[source]¶: 此方法必须处理指令参数、选项和内容，并返回 Docutils/Sphinx 节点的列表，这些节点将插入到遇到指令的文档树中。

始终在指令上设置的实例属性是

name¶: 指令名称（在多个名称下注册同一个指令类时很有用）。

arguments¶: 给定给指令的参数，作为列表。

options¶: 给定给指令的选项，作为选项名称到已验证/转换值的字典。

content¶: 指令内容（如果给定），作为 ViewList。

lineno¶: 指令出现的绝对行号。这并不总是一个有用的值；请改用 srcline。

content_offset¶: 指令内容的内部偏移量。在调用 nested_parse 时使用（见下文）。

block_text¶: 包含整个指令的字符串。

state¶
state_machine¶: 控制解析的状态和状态机。用于 nested_parse。

另请参阅

Docutils 文档的创建指令 HOWTO

将指令内容解析为 reStructuredText¶

许多指令将包含必须解析的更多标记。为此，请使用 run() 方法中的以下 API 之一

第一个方法将指令的所有内容解析为标记，而第二个方法只解析给定的 text 字符串。两种方法都以列表形式返回解析后的 Docutils 节点。

这些方法的使用如下

def run(self) -> list[Node]:
    # either
    parsed = self.parse_content_to_nodes()
    # or
    parsed = self.parse_text_to_nodes('spam spam spam')
    return parsed

注意

上述实用方法是在 Sphinx 7.4 中添加的。在 Sphinx 7.4 之前，应使用以下方法解析内容

self.state.nested_parse
sphinx.util.nodes.nested_parse_with_titles() – 这允许在解析的内容中包含标题。

def run(self) -> list[Node]:
    container = docutils.nodes.Element()
    # either
    nested_parse_with_titles(self.state, self.result, container, self.content_offset)
    # or
    self.state.nested_parse(self.result, self.content_offset, container)
    parsed = container.children
    return parsed

要解析内联标记，请使用 parse_inline()。这只适用于单行或单段文本，不包含任何结构元素（标题、转换、指令等）。

注意

sphinx.util.docutils.switch_source_input() 允许在指令中解析内容时更改源（输入）文件。它对于解析混合内容很有用，例如在 sphinx.ext.autodoc 中，它用于解析 docstrings。

from sphinx.util.docutils import switch_source_input
from sphinx.util.parsing import nested_parse_to_nodes

# Switch source_input between parsing content.
# Inside this context, all parsing errors and warnings are reported as
# happened in new source_input (in this case, ``self.result``).
with switch_source_input(self.state, self.result):
    parsed = nested_parse_to_nodes(self.state, self.result)

自版本 1.7 起废弃: 在 Sphinx 1.6 之前，sphinx.ext.autodoc.AutodocReporter 用于此目的。它已被 switch_source_input() 取代。

ViewLists 和 StringLists¶

Docutils 在 docutils.statemachine 模块中的 StringList 类中表示文档源行，该类继承自 ViewList。这是一个具有扩展功能的列表，包括切片会创建原始列表的视图，并且列表包含有关源行号的信息。

Directive.content 属性是一个 StringList。如果要生成要解析为 reStructuredText 的内容，则必须为 Docutils API 创建一个 StringList。Sphinx 提供的实用函数会自动处理此问题。对于内容生成，以下几点很重要

ViewList 构造函数接受一个字符串（行）列表和一个源（文档）名称。
ViewList.append() 方法也接受一行和一个源名称。