python-sphinx – 在Sphinx中使用带有词汇表的noindex

2019年8月4日 199次阅读

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

我尝试过：noindex：在四个地方：

词汇表之前和之后使词汇表消失.

.. :noindex: glossary:: 

    `term`
        definition

.. glossary:: :noindex:

    `term`
        definition

把它与术语放在一起使得术语可点击并显示：noindex：.

.. glossary:: 

    :noindex: `term`
        definition

.. glossary:: 

    `term` :noindex:
        definition

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

最佳答案 据我了解,glossary指令为每个术语创建了钩子,可以从文档中的任何地方轻松引用;这将最终在某个地方的某个索引中结束,至少在构建时内部.

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

 term_1
   definition for term_1

 term_2
   definition for term_2

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

如果要在此类列表中明确包含某些术语,可以使用：index：role.

 :index:`term_3`
   definition for an indexed term

这些术语现在将出现在索引中.但是,除非条款很少,否则这是实现词汇表为您所做的事情的一种笨重方式;并且失去了使用交叉引用的能力(使用语法：term：`term_1`).

点赞