事件回调API

将回调函数连接到事件是扩展 Sphinx 的一种简单方法，可以通过在构建过程中的各个点进行挂钩来实现。

在扩展的 setup 函数中，或在项目 conf.py 中的 setup 函数中，使用 Sphinx.connect() 将函数连接到事件。

def source_read_handler(app, docname, source):
    print('do something here...')

def setup(app):
    app.connect('source-read', source_read_handler)

另请参阅

扩展可以使用 Sphinx.add_event() 添加自己的事件，并通过 EventManager.emit() 或 EventManager.emit_firstresult() 调用它们。

核心事件概览

以下是构建过程中发生的核心事件概述。

1. event.config-inited(app,config)
2. event.builder-inited(app)
3. event.env-get-outdated(app, env, added, changed, removed)
4. event.env-before-read-docs(app, env, docnames)

for docname in docnames:
   5. event.env-purge-doc(app, env, docname)

   if doc changed and not removed:
      6. source-read(app, docname, source)
      7. run source parsers: text -> docutils.document
         - parsers can be added with the app.add_source_parser() API
         - event.include-read(app, relative_path, parent_docname, content)
           is called for each include directive
      8. apply transforms based on priority: docutils.document -> docutils.document
         - event.doctree-read(app, doctree) is called in the middle of transforms,
           transforms come before/after this event depending on their priority.

9. event.env-merge-info(app, env, docnames, other)
   - if running in parallel mode, this event will be emitted for each process

10. event.env-updated(app, env)
11. event.env-get-updated(app, env)

if environment is written to disk:
   12. event.env-check-consistency(app, env)

13. event.write-started(app, builder)
    - This is called after ``app.parallel_ok`` has been set,
      which must not be altered by any event handler.

# The updated-docs list can be builder dependent, but generally includes all new/changed documents,
# plus any output from `env-get-updated`, and then all "parent" documents in the ToC tree
# For builders that output a single page, they are first joined into a single doctree before post-transforms
# or the doctree-resolved event is emitted
for docname in updated-docs:
   14. apply post-transforms (by priority): docutils.document -> docutils.document
   15. event.doctree-resolved(app, doctree, docname)
       - In the event that any reference nodes fail to resolve, the following may emit:
       - event.missing-reference(app, env, node, contnode)
       - event.warn-missing-reference(app, domain, node)

16. Generate output files
17. event.build-finished(app, exception)

这里还有一份事件流程图，展示了其在 Sphinx 构建过程中的上下文。

Sphinx 核心事件流程

核心事件详情

以下是这些事件的更详细列表。

config-inited(app, config)

参数:

• app – Sphinx

• config – Config

当配置对象已初始化时触发。

版本 1.8 中新增。

builder-inited(app)

参数:

app – Sphinx

当构建器对象已创建（通过 app.builder 可用）时触发。

env-get-outdated(app, env, added, changed, removed)

参数:

• app – Sphinx

• env – BuildEnvironment

• added – Set[str]

• changed – Set[str]

• removed – Set[str]

返回:

Sequence[str] 额外需要重新读取的文档名

当环境确定哪些源文件已更改并应重新读取时触发。added、changed 和 removed 是环境已确定的文档名集合。您可以返回一个文档名列表，以在这些文档名之外额外重新读取。

版本 1.1 新增。

env-purge-doc(app, env, docname)

参数:

• app – Sphinx

• env – BuildEnvironment

• docname – str

当源文件应从环境中完全清除时触发，即如果源文件被删除或在重新读取之前。这适用于在环境属性中维护其自身缓存的扩展。

例如，环境中有一个所有模块的缓存。当源文件更改时，缓存中该文件的条目会被清除，因为模块声明可能已从文件中删除。

版本 0.5 中新增。

env-before-read-docs(app, env, docnames)

参数:

• app – Sphinx

• env – BuildEnvironment

• docnames – list[str]

在环境确定所有添加和更改的文件列表之后、即将读取它们之前触发。它允许扩展作者在处理前重新排序文档名列表（原地），或添加 Sphinx 未认为是已更改的更多文档名（但绝不能添加任何不在 found_docs 中的文档名）。

您也可以删除文档名；请谨慎操作，因为这会使 Sphinx 将更改的文件视为未更改。

版本 1.3 中添加。

source-read(app, docname, content)

参数:

• app – Sphinx

• docname – str

• content – 包含一个元素的 list[str]，表示所包含文件的内容。

读取源文件时触发。

您可以处理 content 并替换此项以实现源级转换。

例如，如果您想使用 $ 符号来分隔内联数学，就像在 LaTeX 中一样，您可以使用正则表达式将 $...$ 替换为 :math:`...`。

版本 0.5 中新增。

include-read(app, relative_path, parent_docname, content)

参数:

• app – Sphinx

• relative_path – 表示相对于源目录的包含文件的 Path。

• parent_docname – 包含 include 指令的文档名 str。

• content – 包含一个元素的 list[str]，表示所包含文件的内容。

通过 include 指令读取文件时触发。

您可以处理 content 并替换此项以转换包含的内容，如同 source-read 事件一样。

7.2.5 版本新增。

另请参阅

include 指令和 source-read 事件。

object-description-transform(app, domain, objtype, contentnode)

参数:

• app – Sphinx

• domain – str

• objtype – str

• contentnode – desc_content

当对象描述指令运行时触发。domain 和 objtype 参数是字符串，指示对象的对象描述。contentnode 是对象的内容。它可以在原地修改。

2.4 版本新增。

doctree-read(app, doctree)

参数:

• app – Sphinx

• doctree – docutils.nodes.document

当文档树被环境解析和读取后，即将被序列化时触发。doctree 可以在原地修改。

missing-reference(app, env, node, contnode)

参数:

• app – Sphinx

• env – BuildEnvironment

• node – 待解析的 pending_xref 节点。其 reftype、reftarget、modname 和 classname 属性决定了引用的类型和目标。

• contnode – 携带未来引用内部文本和格式的节点，应作为返回的引用节点的子节点。

返回:

一个新节点，用于替换文档树中的节点，或者 None 以让其他处理程序尝试。

当无法解析对对象的交叉引用时触发。如果事件处理程序可以解析引用，它应该返回一个新的 docutils 节点，插入到文档树中替换节点 node。通常，此节点是一个包含 contnode 作为子节点的 reference 节点。如果处理程序无法解析交叉引用，它可以返回 None 以让其他处理程序尝试，或者引发 NoUri 以阻止其他处理程序尝试并抑制有关此交叉引用未解析的警告。

版本 0.5 中新增。

warn-missing-reference(app, domain, node)

参数:

• app – Sphinx

• domain – 缺失引用的 Domain。

• node – 未能解析的 pending_xref 节点。

返回:

如果发出了警告，则为 True，否则为 None

即使在 missing-reference 之后，仍无法解析对对象的交叉引用时触发。如果事件处理程序可以对缺失引用发出警告，它应返回 True。配置变量 nitpick_ignore 和 nitpick_ignore_regex 会阻止针对相应节点触发此事件。

3.4 版本新增。

doctree-resolved(app, doctree, docname)

参数:

• app – Sphinx

• doctree – docutils.nodes.document

• docname – str

当文档树已被环境“解析”，即所有引用都已解析且目录已插入时触发。doctree 可以在原地修改。

这里是替换在写入器中没有访问器方法的自定义节点的地方，这样它们在写入器遇到时就不会导致错误。

env-merge-info(app, env, docnames, other)

参数:

• app – Sphinx

• env – BuildEnvironment

• docnames – list[str]

• other – BuildEnvironment

此事件仅在启用文档并行读取时触发。它为每个已读取某些文档的子进程触发一次。

您必须在将数据存储在环境中的自定义位置的扩展中处理此事件。否则，主进程中的环境将不会知道子进程中存储的信息。

other 是来自子进程的环境对象，env 是来自主进程的环境。docnames 是在子进程中已读取的文档名集合。

版本 1.3 中添加。

env-updated(app, env)

参数:

• app – Sphinx

• env – BuildEnvironment

返回:

可迭代的 str

在读取所有文档之后，当环境和所有文档树都已更新时触发。

您可以从处理程序返回一个文档名可迭代对象。这些文档随后将被视为已更新，并将在写入阶段（重新）写入。

版本 0.5 中新增。

1.3 版本更改: 处理程序的返回值现在被使用。

env-get-updated(app, env)

参数:

• app – Sphinx

• env – BuildEnvironment

返回:

可迭代的 str

当环境确定哪些源文件已更改并应重新读取时触发。您可以返回一个可迭代的文档名以重新读取。

env-check-consistency(app, env)

参数:

• app – Sphinx

• env – BuildEnvironment

在一致性检查阶段触发。您可以检查整个文档的元数据一致性。

版本 1.6 中新增。

write-started(app, builder)

参数:

• app – Sphinx

• builder – Builder

在构建器开始解析和写入文档之前触发。

版本 7.4 新增。

build-finished(app, exception)

参数:

• app – Sphinx

• exception – Exception 或 None

构建完成后，在 Sphinx 退出之前触发，通常用于清理。即使构建过程引发了异常（作为 exception 参数给出），此事件也会触发。在事件处理程序运行后，异常会在应用程序中重新引发。如果构建过程没有引发异常，exception 将为 None。这允许根据异常状态自定义清理操作。

版本 0.5 中新增。

特定构建器事件

这些事件由特定的构建器触发。

html-collect-pages(app)

参数:

app – Sphinx

返回:

可迭代的 (pagename, context, templatename)，其中 pagename 和 templatename 是字符串，context 是 dict[str, Any]。

当 HTML 构建器开始写入非文档页面时触发。

您可以通过从此事件返回一个可迭代对象来添加要写入的页面。

版本 1.0 新增。

html-page-context(app, pagename, templatename, context, doctree)

参数:

• app – Sphinx

• pagename – str

• templatename – str

• context – dict[str, Any]

• doctree – docutils.nodes.document 或 None

返回:

str 或 None

当 HTML 构建器创建了一个上下文字典来渲染模板时触发——这可以用于向上下文中添加自定义元素。

pagename 参数是正在渲染页面的规范名称，即不带 .html 后缀并使用斜杠作为路径分隔符。templatename 是要渲染的模板名称，对于所有 reStructuredText 文档的页面，它将是 'page.html'。

context 参数是一个字典，其中包含提供给模板引擎以渲染页面的值，可以修改以包含自定义值。

当页面从 reStructuredText 文档创建时，doctree 参数将是一个文档树；当页面仅从 HTML 模板创建时，它将是 None。

您可以从处理程序返回一个字符串，它将替换 'page.html' 作为此页面的 HTML 模板。

提示

您可以通过 Sphinx.add_js_file() 和 Sphinx.add_css_file() 为特定页面安装 JS/CSS 文件（自 v3.5.0 起）。

版本 0.4 新增。

1.3 版本更改: 返回值现在可以指定模板名称。

linkcheck-process-uri(app, uri)

参数:

• app – Sphinx

• uri – 收集到的 URI 的 str

返回:

str 或 None

当 linkcheck 构建器从文档中收集超链接时触发。

事件处理程序可以通过返回一个字符串来修改 URI。

版本 4.1 新增。

上一页

应用API

下一页

项目API