我想创建一个“术语”部分,其中包含我正在使用的术语定义,以便每次使用本术语部分中的术语时,都会创建一个指向定义的链接。
目前,我能想到的最好的是:
.. |flavor| replace:: `:ref:flavor`
.. _flavor:
flavor
------
blah blah blah
然后,在我必须做的其他文本中:
''' This is a usage of the word |flavor|.'''
我发现上面的语法非常麻烦。我知道我可以使用另一层脚本或m4自动生成这种语法,但我希望有更好的方法..
答案 0 :(得分:22)
没有那么不同,但您可以使用:
..词汇表::
该指令必须包含带有术语和定义的reST定义列表。然后,定义将与“术语”角色一起引用。
<强>:术语强>
参考词汇表中的术语。词汇表是使用词汇表指令创建的,该指令包含带有术语和定义的定义列表。它不必与术语标记位于同一文件中,例如Python文档在glossary.rst文件中有一个全局词汇表。
如果您使用术语表中未解释的术语,则在构建期间会收到警告。