在 Sphinx 中，如何在没有大量开销的情况下创建可链接的“术语”部分？

Posted 2023-03-31

【中文标题】在 Sphinx 中，如何在没有大量开销的情况下创建可链接的“术语”部分？

【英文标题】：In Sphinx, how can I create a linkable "terminology" section without massive overhead?

【发布时间】：2011-04-15 09:08:12

【问题描述】：

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

目前，我能想到的最好的是：

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

.. _flavor:

flavor
------
blah blah blah

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

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

我发现上面的语法很麻烦。我知道我可以使用另一层脚本或 m4 来自动生成这种语法，但我希望有更好的方法..

【参考方案1】：

没什么不同，但你可以使用：

.. 词汇表::

该指令必须包含一个带有术语和定义的 reST 定义列表。然后，这些定义将被“术语”角色引用。

:term:

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

如果您使用词汇表中未解释的术语，您将在构建期间收到警告。

[从official sphinx documentation]粘贴​​p>

【讨论】：

我想在搜索 sphinx 文档时，我应该查阅同义词库，为“术语”找到不同的词。谢谢eolo999。