生成器API

待处理

展开这个。

class sphinx.builders.Builder[源代码]

这是所有构建器的基类。

应在构建器类上设置这些属性:

name = ''

构建器的名称,用于 -b 命令行选项。

format = ''

构建器的输出格式,或者“如果没有生成文档输出”。

epilog = ''

成功构建完成后发出的消息。 这可以是一个printf样式的模板字符串,其中包含以下键: outdirproject

supported_image_types = []

构建器支持的图像格式的MIME类型列表。将按照图像文件在此处显示的顺序搜索图像文件。

supported_remote_images = False

构建器是否支持远程图像。

supported_data_uri_images = False

构建器是否支持数据URI。

default_translator_class = None

构建器的默认转换器类。 这可以被覆盖 app.set_translator()

这些方法是预定义的,将从应用程序中调用:

get_relative_uri(from_: str, to: str, typ: str = None) → str[源代码]

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

如果没有办法返回合理的URI,可能会引发环境.NoUri。

build_all() → None[源代码]

构建所有源文件。

build_specific(filenames: List[str]) → None[源代码]

仅重建 filenames 中的更改所需的内容。

build_update() → None[源代码]

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

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

主要构建方法。

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

可以在具体构建器类中重写这些方法:

init() → None[源代码]

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

get_outdated_docs() → Union[str, Iterable[str]][源代码]

返回过时的可迭代输出文件,或者描述更新构建将构建的字符串。

如果构建器未输出与源文件对应的单个文件,请在此处返回一个字符串。 如果是,则返回需要写入的那些文件的可迭代。

get_target_uri(docname: str, typ: str = None) → str[源代码]

返回文档名称的目标URI。

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

prepare_writing(docnames: Set[str]) → None[源代码]

你可以在之前添加逻辑的地方 write_doc() 运行

write_doc(docname: str, doctree: docutils.nodes.document) → None[源代码]

你真正在文件系统中写东西的地方。

finish() → None[源代码]

完成建设过程。

默认实现什么都不做。