术语

构建器

一个类(继承自 Builder )，它接受已分析的文档并对它们执行操作。通常，构建器将文档转换为输出格式，但也可以使用构建器构建器，例如，检查文档中是否存在损坏的链接，或构建覆盖率信息。

查看 构建器 有关Sphinx内置构建器的概述。

配置目录

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

指令

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

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

   Content of the directive.

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

文件名

由于reST源文件可以有不同的扩展名(有些人喜欢 .txt ，有些像 .rst – 扩展名可以配置 source_suffix)，不同的操作系统有不同的路径分隔符， Sphinx抽象它们: document names 总是相对于 source directory ，扩展被剥离，路径分隔符被转换为斜杠。 所有引用 “documents” 的值，参数等都需要这样的文档名称。

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

域

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

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

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

环境

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

扩展

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

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

主文件

包含root的文件 toctree 指令。

对象

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

RemoveInSphinxXXXWarning

警告的功能将在Sphinx-XXX版本中删除。它通常是由使用过时的Sphinx扩展引起的。另见 弃用警告 。

角色

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

源目录

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

reStructuredText

一个易于阅读，你看到的是什么，你得到的纯文本标记语法和解析器系统。