6

使用 Sphinx 1.1.3 时,如何创建.. glossary::未显示在自动生成的索引中的条目?

我尝试:noindex:了四个地方:

词汇表前后使词汇表消失。

.. :noindex: glossary:: 

    `term`
        definition

.. glossary:: :noindex:

    `term`
        definition

将其与术语放在一起使术语可点击并显示:noindex:.

.. glossary:: 

    :noindex: `term`
        definition

.. glossary:: 

    `term` :noindex:
        definition

我的术语有特殊字符,所以我特意用反引号括起来。

4

1 回答 1

2

据我了解,该glossary指令为每个可以从文档中的任何位置轻松引用的术语创建挂钩;这最终会出现在某个索引中,至少在构建时内部是这样。

要解决此问题,您可以使用标准定义列表:

 term_1
   definition for term_1

 term_2
   definition for term_2

然后,这些定义将仅在本地写入,不会出现在主索引中。有关语法的更多详细信息,请参阅reST 文档

如果您想在此类列表中明确包含某些术语,则可以使用该:index:角色。

 :index:`term_3`
   definition for an indexed term

这些术语现在将出现在索引中。但是,除非是很少的术语,否则这是实现词汇表为您提供的功能的笨拙方式;并且失去了使用交叉引用的能力(使用 syntax :term:`term_1`)。

于 2013-01-15T11:19:49.687 回答