在Sphinx中,我怎样才能在没有大量开销的情况下创建一个可链接的 "术语 "部分?

问题描述 投票:8回答:1

我想创建一个包含术语定义的 "术语 "部分,这样每次我在这个术语部分使用术语时,都会创建一个指向定义的链接。

目前,我能想到的最好的办法是。

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

.. _flavor:

flavor
------
blah blah blah

然后,在其他文本中,我必须这样做,

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

我觉得上面的语法非常繁琐。 我知道我可以使用另一层脚本或m4来自动生成这种语法,但我希望有更好的方法。

python-sphinx restructuredtext glossary
1个回答
23
投票

不太一样,但你可以使用。

...词汇表::

这个指令必须包含一个包含术语和定义的reST定义列表。这些定义将可以用'term'角色来引用。

:term.::这个指令必须包含一个包含术语和定义的reST定义列表,然后定义可以用'term'角色来引用。

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

如果你使用了一个没有在术语表中解释的术语,你会在构建过程中得到一个警告。

[粘贴自 狮身人面像官方文件]

© www.soinside.com 2019 - 2024. All rights reserved.