在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`）。