生成器API

待处理

展开这个。

class sphinx.builders.Builder

这是所有建筑商的基本等级。

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

name = ''

生成器的名称，用于-b命令行选项。

format = ''

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

epilog = ''

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

allow_parallel = False

允许并行的WRITE_DOC()调用

supported_image_types: list[str] = []

生成器支持的图像格式的mime类型列表。图像文件按显示顺序进行搜索。

supported_remote_images = False

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

supported_data_uri_images = False

生成器是否支持数据URI。

default_translator_class: type[nodes.NodeVisitor]

生成器的默认转换程序类。这可以通过以下方式覆盖 set_translator() 。

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

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

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

如果无法返回合理的URI，则可能引发environment.no 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

主要构建方法。

首先更新环境，然后调用 write() 。

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

init() → None

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

get_outdated_docs() → str | Iterable[str]

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

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

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

返回文档名的目标URI。

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

prepare_writing(docnames: set[str]) → None

你可以在这里添加逻辑 write_doc() 运行

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

在这里您实际上向文件系统写入了一些东西。

finish() → None

完成建造过程。

默认实现什么也不做。

Attributes

events

安 EventManager 对象。