在Sphinx中使用noindex与词汇表。

Question

当使用Sphinx 1.1.3时，如何创建一个 .. glossary:: 条目不显示在自动生成的索引中？

我试过 :noindex: 在四个地方。

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

.. :noindex: glossary:: 

    `term`
        definition

.. glossary:: :noindex:

    `term`
        definition

而将其与术语放在一起，则使该术语可点击并显示出 :noindex:.

.. glossary:: 

    :noindex: `term`
        definition

.. glossary:: 

    `term` :noindex:
        definition

我的术语有特殊的字符，所以我特意用回标把它括起来。

Answer 1

根据我的理解 glossary 指令为每一个术语创建了钩子，这些钩子可以很容易地从文档中的任何地方引用；而且这些钩子最终会被放在某个索引中，至少在构建时是在内部。

为了解决这个问题，你可以使用一个标准的定义列表。

 term_1
   definition for term_1

 term_2
   definition for term_2

这些定义将只被写入本地，而不会出现在主索引中。请看 reST docs 以获得更多关于语法的细节。

如果你想在这样的列表中明确包含一些术语，你可以使用 :index: 角色。

 :index:`term_3`
   definition for an indexed term

而这些术语现在将出现在索引中。 然而，除非是非常少的术语，否则这是一种笨拙的方式来实现词汇表为你做的事情；并且失去了使用交叉引用的能力（使用语法 :term:`term_1`).