sphinx.ext.autosectionlabel --允许引用节使用其标题

Added in version 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

如果设置了，AutoSectionLabel将按深度选择要标记的部分。例如，将1设置为 autosectionlabel_maxdepth ，仅为顶层部分生成标签，而深层部分不标记。它默认为 None （残疾）。

除错

这个 WARNING: undefined label 表示您在 ref 拼错了。正在调用 sphinx-build 使用 -vv (见 -v )将打印所有区段名称和已为其生成的标签。此输出有助于找到正确的参考标签。