词汇表¶

构建器¶

一个类（继承自 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¶

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