首页 > 解决方案 > 如何引用以单数定义但以复数表示的词汇表术语?

问题描述

如果我定义 aglossary和一个名为 的术语foobar,那么我可以将文本中的该术语用作

This is a ref to the :term:`foobar` term.

然后,这将foobar成为一个可点击的参考,将我带到词汇表。

但是,如果我想引用一个术语但以不同的方式显示它,例如,以复数形式显示,例如“我有很多 foobars”,其中 foobar 被识别为术语并链接到词汇表,该怎么办?

以下将不会作为紧跟在结束反勾号之后的字符将其弄乱,因此它根本不会被识别为术语链接。

I have many :term:`foobar`s

在 s 之前添加一个空格显然看起来很糟糕。如果可以将整个单词“foobars”标记为术语的链接,那就太好了foobar。这可能吗?

标签: python-sphinxrestructuredtextglossary

解决方案


参见例如https://sublime-and-sphinx-guide.readthedocs.io/en/latest/glossary.html

您可以链接到词汇表中的术语,同时在主题中显示不同的文本,方法是将术语包含在尖括号中。例如:

:term:`reStructuredText<RST>`

尖括号中的术语必须与词汇表中的术语完全匹配。尖括号之前的文本是用户在页面上看到的内容。

在你的情况下:

I have many :term:`foobars<foobar>`

如果您不喜欢重复,请参阅以复数形式编写术语而没有冗余


推荐阅读