实用程序¶
Sphinx 提供了用于开发扩展的实用程序类和函数。
组件基类¶
这些基类有助于使您的扩展能够轻松地获取 Sphinx 组件(例如 Config
、BuildEnvironment
等)。
注意
它们的子类可能无法与裸露的 docutils 一起使用,因为它们与 Sphinx 紧密耦合。
- class sphinx.transforms.SphinxTransform(document, startnode=None)[source]¶
转换的基类。
与
docutils.transforms.Transform
相比,此类提高了对 Sphinx API 的可访问性。- property env: BuildEnvironment¶
对
BuildEnvironment
对象的引用。
- class sphinx.transforms.post_transforms.SphinxPostTransform(document, startnode=None)[source]¶
后置转换的基类。
后置转换用于修改文档以重构其输出结构。它们解析引用、转换图像、对每种输出格式进行特殊转换等等。此类有助于实现这些后置转换。
- class sphinx.util.docutils.SphinxDirective(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)[source]¶
Sphinx 指令的基类。
此类为 Sphinx 指令提供了辅助方法。
版本 1.8 中新增。
注意
此类的子类可能无法与 docutils 一起使用。此类与 Sphinx 紧密耦合。
- parse_content_to_nodes(allow_section_headings: bool = False) list[Node] [source]¶
将指令的内容解析为节点。
- 参数:
allow_section_headings – 指令内容中是否允许标题(章节)?请注意,此选项绕过了 Docutils 对 doctree 结构的常规检查,错误使用此选项可能导致 doctree 不连贯。在 Docutils 中,章节节点只能是
Structural
节点的子节点,其中包括document
、section
和sidebar
节点。
版本 7.4 中新增。
- parse_inline(text: str, *, lineno: int = -1) tuple[list[Node], list[system_message]] [source]¶
将 text 解析为内联元素。
- 参数:
text – 要解析的文本,应为单行或段落。它不能包含任何结构元素(标题、分隔符、指令等)。
lineno – 解释文本开始的行号。
- 返回值:
节点列表(文本和内联元素)以及系统消息列表。
版本 7.4 中新增。
- parse_text_to_nodes(text: str = '', /, *, offset: int = -1, allow_section_headings: bool = False) list[Node] [source]¶
将 text 解析为节点。
- 参数:
text – 字符串形式的文本。也接受
StringList
。allow_section_headings – text 中是否允许标题(章节)?请注意,此选项绕过了 Docutils 对 doctree 结构的常规检查,错误使用此选项可能导致 doctree 不连贯。在 Docutils 中,章节节点只能是
Structural
节点的子节点,其中包括document
、section
和sidebar
节点。offset – 内容的偏移量。
版本 7.4 中新增。
- property env: BuildEnvironment¶
对
BuildEnvironment
对象的引用。版本 1.8 中新增。
- class sphinx.util.docutils.SphinxRole[source]¶
Sphinx 角色的基类。
此类为 Sphinx 角色提供辅助方法。
版本 2.0 中新增。
注意
此类的子类可能无法与 docutils 一起使用。此类与 Sphinx 紧密耦合。
- property env: BuildEnvironment¶
对
BuildEnvironment
对象的引用。版本 2.0 中新增。
- inliner: Inliner¶
docutils.parsers.rst.states.Inliner
对象。
- class sphinx.util.docutils.ReferenceRole[source]¶
引用角色的基类。
引用角色可以接受
link title <target>
样式作为角色的文本。解析结果;链接标题和目标将存储到self.title
和self.target
中。版本 2.0 中新增。
- class sphinx.transforms.post_transforms.images.ImageConverter(document, startnode=None)[source]¶
图像转换器的基类。
图像转换器是一种 Docutils 转换模块。它用于将构建器不支持的图像文件转换为该构建器适用的格式。
例如,
LaTeX builder
支持 PDF、PNG 和 JPEG 作为图像格式。但是它不支持 SVG 图像。在这种情况下,使用图像转换器可以将这些不受支持的图像嵌入到文档中。其中一个图像转换器;sphinx.ext.imgconverter 可以使用 Imagemagick 内部将 SVG 图像转换为 PNG 格式。制作自定义图像转换器需要三个步骤
创建
ImageConverter
类的子类覆盖
conversion_rules
、is_available()
和convert()
使用
Sphinx.add_post_transform()
将你的图像转换器注册到 Sphinx
- conversion_rules: list[tuple[str, str]] = []¶
图像转换器支持的转换规则。它表示为源图像格式(mime 类型)和目标格式的配对列表
conversion_rules = [ ('image/svg+xml', 'image/png'), ('image/gif', 'image/png'), ('application/pdf', 'image/png'), ]
- default_priority = 200¶
此转换的数字优先级,0 到 999(覆盖)。
实用程序组件¶
- class sphinx.events.EventManager(app: Sphinx)[source]¶
Sphinx 的事件管理器。
- connect(name: Literal['config-inited'], callback: Callable[[Sphinx, Config], None], priority: int) int [source]¶
- connect(name: Literal['builder-inited'], callback: Callable[[Sphinx], None], priority: int) int
- connect(name: Literal['env-get-outdated'], callback: Callable[[Sphinx, BuildEnvironment, Set[str], Set[str], Set[str]], Sequence[str]], priority: int) int
- connect(name: Literal['env-before-read-docs'], callback: Callable[[Sphinx, BuildEnvironment, list[str]], None], priority: int) int
- connect(name: Literal['env-purge-doc'], callback: Callable[[Sphinx, BuildEnvironment, str], None], priority: int) int
- connect(name: Literal['source-read'], callback: Callable[[Sphinx, str, list[str]], None], priority: int) int
- connect(name: Literal['include-read'], callback: Callable[[Sphinx, Path, str, list[str]], None], priority: int) int
- connect(name: Literal['doctree-read'], callback: Callable[[Sphinx, nodes.document], None], priority: int) int
- connect(name: Literal['env-merge-info'], callback: Callable[[Sphinx, BuildEnvironment, list[str], BuildEnvironment], None], priority: int) int
- connect(name: Literal['env-updated'], callback: Callable[[Sphinx, BuildEnvironment], str], priority: int) int
- connect(name: Literal['env-get-updated'], callback: Callable[[Sphinx, BuildEnvironment], Iterable[str]], priority: int) int
- connect(name: Literal['env-check-consistency'], callback: Callable[[Sphinx, BuildEnvironment], None], priority: int) int
- connect(name: Literal['write-started'], callback: Callable[[Sphinx, Builder], None], priority: int) int
- connect(name: Literal['doctree-resolved'], callback: Callable[[Sphinx, nodes.document, str], None], priority: int) int
- connect(name: Literal['missing-reference'], callback: Callable[[Sphinx, BuildEnvironment, addnodes.pending_xref, nodes.TextElement], nodes.reference | None], priority: int) int
- connect(name: Literal['warn-missing-reference'], callback: Callable[[Sphinx, Domain, addnodes.pending_xref], bool | None], priority: int) int
- connect(name: Literal['build-finished'], callback: Callable[[Sphinx, Exception | None], None], priority: int) int
- connect(name: Literal['html-collect-pages'], callback: Callable[[Sphinx], Iterable[tuple[str, dict[str, Any], str]]], priority: int) int
- connect(name: Literal['html-page-context'], callback: Callable[[Sphinx, str, str, dict[str, Any], nodes.document], str | None], priority: int) int
- connect(name: Literal['linkcheck-process-uri'], callback: Callable[[Sphinx, str], str | None], priority: int) int
- connect(name: Literal['object-description-transform'], callback: Callable[[Sphinx, str, str, addnodes.desc_content], None], priority: int) int
- connect(name: Literal['autodoc-process-docstring'], callback: Callable[[Sphinx, Literal['module', 'class', 'exception', 'function', 'method', 'attribute'], str, Any, dict[str, bool], Sequence[str]], None], priority: int) int
- connect(name: Literal['autodoc-before-process-signature'], callback: Callable[[Sphinx, Any, bool], None], priority: int) int
- connect(name: Literal['autodoc-process-signature'], callback: Callable[[Sphinx, Literal['module', 'class', 'exception', 'function', 'method', 'attribute'], str, Any, dict[str, bool], str | None, str | None], tuple[str | None, str | None] | None], priority: int) int
- connect(name: Literal['autodoc-process-bases'], callback: Callable[[Sphinx, str, Any, dict[str, bool], list[str]], None], priority: int) int
- connect(name: Literal['autodoc-skip-member'], callback: Callable[[Sphinx, Literal['module', 'class', 'exception', 'function', 'method', 'attribute'], str, Any, bool, dict[str, bool]], bool], priority: int) int
- connect(name: Literal['todo-defined'], callback: Callable[[Sphinx, todo_node], None], priority: int) int
- connect(name: Literal['viewcode-find-source'], callback: Callable[[Sphinx, str], tuple[str, dict[str, tuple[Literal['class', 'def', 'other'], int, int]]]], priority: int) int
- connect(name: Literal['viewcode-follow-imported'], callback: Callable[[Sphinx, str, str], str | None], priority: int) int
- connect(name: str, callback: Callable[..., Any], priority: int) int
连接处理程序到特定事件。
实用程序函数¶
- sphinx.util.parsing.nested_parse_to_nodes(state: RSTState, text: str | StringList, *, source: str = '<generated text>', offset: int = 0, allow_section_headings: bool = True, keep_title_context: bool = False) list[Node] [source]¶
将 text 解析为节点。
- 参数:
**state** – 状态机状态。必须是
RSTState
的子类。text – 字符串形式的文本。也接受
StringList
。**source** – 文本的来源,在创建新的
StringList
时使用。offset – 内容的偏移量。
allow_section_headings – text 中是否允许标题(章节)?请注意,此选项绕过了 Docutils 对 doctree 结构的常规检查,错误使用此选项可能导致 doctree 不连贯。在 Docutils 中,章节节点只能是
Structural
节点的子节点,其中包括document
、section
和sidebar
节点。**keep_title_context** – 如果为 False(默认值),则解析 content 时将其视为独立文档,这意味着标题装饰(例如下划线)不需要与周围文档匹配。当解析的内容来自完全不同的上下文(例如文档字符串)时,这很有用。如果为 True,则标题下划线必须与周围文档中的标题下划线匹配,否则行为未定义。
版本 7.4 中新增。