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¶
- 类型:
bool- 默认:
False
如果为True，则在每个节标签前面加上它所在的文档的名称，后跟冒号。例如,
index:Introduction对于一个名为Introduction显示在文档中的index.rst。当相同的节标题出现在不同的文档中时，有助于避免歧义。
- autosectionlabel_maxdepth¶
- 类型:
int | None- 默认:
None
如果已设置，autosectionLabel将根据深度选择要标记的部分。例如，当将1设置为
autosectionlabel_maxdepth，仅为顶层部分生成标签，而更深的部分不进行标签。 它默认为None(i.e.所有部分均已标记）。
除错¶
的 WARNING: undefined label 表明您在 ref 拼写错误调用 sphinx-build 与 -vvv （见 -v ）将打印所有部分名称和为其生成的标签。此输出可以帮助找到正确的参考标签。