生成器接口

待处理

扩展它。

class sphinx.builders.Builder

这是所有生成器的基类。

应在生成器类上设置这些属性：

name = ''

编译器的名称，用于-b命令行选项。

format = ''

生成器的输出格式，如果未生成文档输出，则为“”。

epilog = ''

成功完成生成时发出的消息。这可以是一个printf样式的模板字符串，具有以下键：outdir，project

allow_parallel = False

allow parallel write_doc() calls

supported_image_types: list[str] = []

生成器支持的图像格式的MIME类型列表。图像文件按它们在此处出现的顺序进行搜索。

supported_remote_images = False

生成器是否支持远程映像。

supported_data_uri_images = False

生成器是否支持数据uri。

default_translator_class: type[nodes.NodeVisitor]

default translator class for the builder. This can be overridden by set_translator().

这些方法是预定义的，将从应用程序调用：

get_relative_uri(from_: str, to: str, typ: str | None = None) → str

返回两个源文件名之间的相对URI。

可能会提高环境.NoUri如果没有办法返回一个合理的URI。

build_all() → None

生成所有源文件。

build_specific(filenames: list[str]) → None

仅根据需要重新生成*文件名*中的更改。

build_update() → None

仅重建自上次生成以来更改或添加的内容。

build(docnames: Iterable[str] | None, summary: str | None = None, method: str = 'update') → None

主构建方法。

First updates the environment, and then calls write().

这些方法可以在具体生成器类中重写：

init() → None

加载必要的模板并执行初始化。默认实现什么也不做。

get_outdated_docs() → str | Iterable[str]

返回一个过时的输出文件的迭代器，或一个描述更新生成将生成什么的字符串。

如果生成器没有输出与源文件对应的单个文件，请在此处返回一个字符串。如果是，则返回需要写入的文件的迭代器。

get_target_uri(docname: str, typ: str | None = None) → str

返回文档名的目标URI。

*typ*可用于限定单个构建器的链接特性。

prepare_writing(docnames: set[str]) → None

在运行：meth:`writeu doc`之前可以添加逻辑的地方

write_doc(docname: str, doctree: document) → None

在那里你实际上写了一些东西到文件系统。

finish() → None

完成构建过程。

默认实现什么也不做。

属性

events

An:类：`.EventManager`对象。