sphinx.ext.autosectionlabel – 允许使用其标题的参考部分

1.4 新版功能.

此扩展程序允许您引用其标题部分。这会影响参考角色（ref）。

例如:

A Plain Title
-------------

This is the text of the section.

It refers to the section title, see :ref:`A Plain Title`.

在内部，此扩展为每个部分生成标签。如果在整个文档中使用相同的节名，则默认情况下任何一个都用于目标。 autosectionlabel_prefix_document 配置变量可用于制作多次出现但在不同文档中唯一的标题。

配置

autosectionlabel_prefix_document

如果为True，则为每个部分标签添加其所在文档的名称，后跟冒号。例如，index:Introduction 是一个名为 Introduction 的部分，出现在文档 index.rst 中。当相同的标题出现在不同的文档中时，可用于避免歧义。

autosectionlabel_maxdepth

如果设置，自动选择标签会根据其深度选择要标记的部分。例如，当将1设置为 autosectionlabel_maxdepth 时，仅为顶级部分生成标签，而不标记更深的部分。它默认为 None （禁用）。