在Sphinx中,如何在没有大量开销的情况下创建可链接的"术语"部分?

Ros*_*ers 8 restructuredtext python-sphinx

我想创建一个定义"术语"一节,我使用这样的,每次我使用这个术语部分的条款时,链接创建方面,它指向的定义.

目前,我能想到的最好的是:

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

.. _flavor:

flavor
------
blah blah blah
Run Code Online (Sandbox Code Playgroud)

然后,在我要做的其他文本中:

''' This is a usage of the word |flavor|.'''
Run Code Online (Sandbox Code Playgroud)

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

小智 22

没有那么不同,但你可以使用:

..词汇表::

该指令必须包含带有术语和定义的reST定义列表.然后,定义将与"术语"角色一起引用.

:术语:

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

如果您使用术语表中未解释的术语,您将在构建期间收到警告.

[粘贴官方sphinx文档]