词汇表¶

构建器¶

一个类（继承自 Builder），它接收解析后的文档并对其执行操作。通常情况下，构建器会将文档转换为输出格式，但也可以使用构建器来执行其他操作，例如检查文档中的断链或构建覆盖率信息。

请参阅构建器以了解 Sphinx 内置构建器的概述。

配置文件目录¶

包含 conf.py 的目录。默认情况下，它与源代码目录相同，但可以使用 -c 命令行选项进行更改。

指令¶

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

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

   Content of the directive.

请参阅指令以获取更多信息。

文档名称¶

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

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

域¶

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

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

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

环境¶

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

扩展¶

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

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

主文档¶

包含根 toctree 指令的文档。

根文档¶

与主文档相同。

对象¶

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

RemoveInSphinxXXXWarning¶

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

角色¶

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

源代码目录¶

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

reStructuredText¶

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