术语表

builder

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

见 Builders 以了解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 ，扩展被剥离，路径分隔符转换为斜线。所有引用“文档”的值、参数等都需要这样的文档名称。

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

域

域是标记（RestructuredText）的集合 directive S和 role s）描述并链接到 object 属于一起的，例如编程语言的元素。域中的指令名和角色名的名称如下 domain:name ，例如 py:function .

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

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

环境

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

延伸

风俗习惯 role ， directive 或者Sphinx的其他方面，允许用户修改Sphinx内部构建过程的任何方面。

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

主文档

包含根目录的文档 toctree 指令。

根文档

相同于 master document 。

对象

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

RemoveInSphinxXXXWarning

警告的功能将在sphinx xxx版本中删除。它通常是由使用不推荐使用的sphinx扩展引起的。也见 折旧警告 .

角色

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

源目录

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

reStructuredText

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