术语表

构建器

一个类（继承自： Builder ）接收已解析的文档并对其执行操作。通常，生成器将文档转换为输出格式，但也可以用生成器来检查文档中的换行，或评估覆盖情况。

请参见：doc:`/usage/builders/index`查看Sphinx内置构建器的概述。

配置目录

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

指令

一种重新构造的文本标记元素，允许用特殊含义标记一个内容块。指令不仅由docutils提供，Sphinx和自定义扩展也可以添加它们自己的。基本指令语法如下所示：

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

   Content of the directive.

有关详细信息，请参见：ref:`rst directives’。

文档名

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

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

域

域是一组标记（structuredText:term:directives和：term:roles），用于描述和链接到：term:objects，属于一起，例如编程语言的元素。域中的指令名和角色名的名称如下``域名：name``，例如`py:function``。

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

For more information, refer to 域.

环境

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

插件

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

有关详细信息，请参阅：doc:/usage/extensions/index。

主控文件

包含根目录的文档：rst:方向：`toctree`指令。

root document

Same as master document.

对象

The basic building block of Sphinx documentation. Every “object directive” (e.g. py:function or object) creates such a block; and most objects can be cross-referenced to.

清除sphinx的警告

在Sphinx XXX版本中，警告的功能将被删除。它通常是由Sphinx扩展引起的，它使用了不推荐使用的扩展。另请参阅：ref:`当显示不推荐警告时’。

角色

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

源目录

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

reStructuredText

一个易读的，你看到的是你得到的明文标记语法和解析器系统。