python-sphinx - 在Sphinx中，如何在没有大量开销的情况下创建可链接的 "terminology"节？

Question

我想创建一个“术语”部分，其中包含我正在使用的术语的定义，以便每次我在此术语部分中使用这些术语时，都会创建一个指向该定义的链接。

目前，我能想到的最好的方法是:

.. |flavor| replace:: `:ref:flavor`

.. _flavor:

flavor
------
blah blah blah

然后，在其他文本中，我必须做:

''' This is a usage of the word |flavor|.'''

我发现上述语法非常繁琐。我知道我可以使用另一层脚本或m4来自动生成此语法，但是我希望有更好的方法。

Answer 1

没什么不同，但是您可以使用:

..词汇表::

该指令必须包含带有术语和定义的reST定义列表。这些定义将以“术语”角色为引用。

:条款:

在词汇表中引用一个术语。使用词汇表指令创建词汇表，该指令包含带有术语和定义的定义列表。它不必与术语标记在同一个文件中，例如Python文档在glossary.rst文件中有一个全局词汇表。

如果您使用的词汇表中没有解释该术语，则会在构建过程中收到警告。

[从official sphinx documentation]粘贴