术语表¶

构建器¶

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

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

配置目录¶

包含 conf.py 文件的目录。默认情况下与 source directory 相同，但可以用 -c 命令行选项进行变更。

指令¶

reStructuredText标记元素，允许用特殊含义标记一个内容块。指令不仅由docutils提供，Sphinx和自定义扩展也可以增加新指令。基本指令语法：

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

   Content of the directive.

有关详细信息，请参见指令。

文档名¶

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

作为例子，文档的名字有 index、 library/zipfile 或 reference/datamodel/types。请注意，没有前导或末尾的斜杠。

域¶

域是一组标记（reStructuredText directives 和 roles），用于描述和链接属于同一类别的 objects，例如编程语言的元素。域中的指令和角色名称类似于 domain:name，例如 py:function。

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

获取更多信息请参阅域。

环境¶

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

扩展¶

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

有关详细信息，请参阅扩展。

主文档¶

根文档¶

包含根 toctree 指令的文档。

对象¶

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

RemoveInSphinxXXXWarning¶

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

角色¶

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

源目录¶

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

reStructuredText¶

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