术语表¶

builder¶

一个类（继承自 Builder），它接受解析后的文档并对其执行操作。通常，builder 将文档转换为输出格式，但也可能使用 builder 来检查文档中的断开链接，或构建覆盖率信息。

请参阅 Builders 以获得 Sphinx 内置 builder 的概述。

configuration directory¶

包含 conf.py 的目录。默认情况下，这与源目录相同，但可以使用 -c 命令行选项进行不同的设置。

directive¶

一个 reStructuredText 标记元素，允许标记具有特殊含义的内容块。指令不仅由 docutils 提供，Sphinx 和自定义扩展也可以添加自己的指令。基本指令语法如下所示

.. directive-name:: argument ...
   :option: value

   Content of the directive.

有关更多信息，请参阅指令。

document name¶

由于 reStructuredText 源文件可以有不同的扩展名（有些人喜欢 .txt，有些人喜欢 .rst – 扩展名可以使用 source_suffix 配置），并且不同的操作系统有不同的路径分隔符，Sphinx 对它们进行了抽象：文档名称始终相对于源目录，扩展名被剥离，路径分隔符被转换为斜杠。所有引用“文档”的值、参数等都期望这样的文档名称。

文档名称的示例包括 index、library/zipfile 或 reference/datamodel/types。请注意，没有前导或尾部斜杠。

domain¶

域是标记的集合（reStructuredText 指令和角色），用于描述和链接到属于一起的对象，例如编程语言的元素。域中的指令和角色名称具有诸如 domain:name 之类的名称，例如 py:function。

拥有域意味着当一组文档想要引用例如 C++ 和 Python 类时，不会出现命名问题。这也意味着支持全新语言文档的扩展更容易编写。

有关更多信息，请参阅域。

environment¶

一个结构，其中保存了根目录下所有文档的信息，并用于交叉引用。环境在解析阶段后被 pickle 序列化，因此后续运行只需要读取和解析新的和更改的文档。

extension¶

Sphinx 的自定义角色、指令或其他方面，允许用户修改 Sphinx 构建过程中的任何方面。

有关更多信息，请参阅扩展。

master document¶

root document¶

包含根 toctree 指令的文档。

object¶

Sphinx 文档的基本构建块。每个“对象指令”（例如 py:function 或 object) 都会创建一个这样的块；并且大多数对象都可以交叉引用。

RemoveInSphinxXXXWarning¶

警告的功能将在 Sphinx-XXX 版本中删除。这通常是由使用已弃用的 Sphinx 扩展引起的。另请参阅弃用警告。

role¶

一个 reStructuredText 标记元素，允许标记一段文本。与指令类似，角色是可扩展的。基本语法如下所示：:rolename:`content`。有关详细信息，请参阅内联标记。

source directory¶

该目录（包括其子目录）包含一个 Sphinx 项目的所有源文件。

reStructuredText¶

一种易于阅读、所见即所得的纯文本标记语法和解析器系统。