术语表

构建器

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

请参见：构建器 查看 Sphinx 内置构建器的概述。

配置目录

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

指令

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

.. directivename:: argument ...
   :option: value

   Content of the directive.

参阅 指令 了解更多信息。

文档名

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

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

域

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

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

有关详细信息，请参阅：域。

环境

保存根目录下所有文档的信息并用于交叉引用的结构。环境在解析阶段之后被处理，因此后续运行只需要读取和解析新的和更改的文档。

插件

自定义 role, directive 或 Sphinx 的其他方面，允许用户修改 Sphinx 中构建过程的任何方面。

有关详细信息，请参阅 插件。

主文件

包含根 toctree 指令的文档。

根文件

与 主文件 同义。

对象

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

清除 Sphinx 的警告

在 Sphinx XXX 版本中，警告的功能将被删除。它通常是由 Sphinx 扩展引起的，它使用了不推荐使用的扩展。另请参阅 Deprecation Warnings。

角色

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

源目录

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

reStructuredText

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