syntax - 如何在 Sphinx 中创建词汇表？

Question

我尝试在书的末尾制作一个词汇表，其中还包含我的文档的标题内容（没有描述，只有对页面的引用）。我想将头条新闻编入词汇表。但是标题需要两行才能起作用，因为您必须在它们下划线。

所以我正在寻找一种将.. glossary::命令与标题相结合的方法，或者使命令在我的标题下不可见。我不想在我的 LaTeX PDF 输出中看到该.. glossary::命令，因为如果我将命令分开，我的头条新闻就会出现两次。我只想看词汇表。

但是每次我尝试时，我的标题都不再突出显示并且不起作用。

它们看起来就像.. note::LaTeX PDF 中的一个盒子，而我的结构不见了。

它的样子：

它应该看起来如何：

也缺少结构，因此关于本指南不再是标题。

它的外观：

它应该看起来如何：

我在互联网上搜索了很多，发现了很多关于.. glossary::语法的描述，但没有与标题相结合。所以我自己尝试了很多不同的方式。这里有一些附近无穷无尽的例子XD，我是如何尝试的：

1.)

.. glossary:: About this Guide
******************************

2.) ..词汇表::

About this Guide
****************

我还在.. glossary::命令下缩进了这部分代码以获得某种块或框，但我的标题不再突出显示并且不起作用。

3.)

About this Guide
****************

.. glossary:: About this Guide

在这次尝试中，我的标题工作正常，但词汇表命令在我的 LaTeX PDF 输出中可见，所以我有两次。

有什么方法可以将我的标题与词汇表命令结合起来，或者使示例 3 中的单独词汇表命令不可见？

Answer 1

如何在 Sphinx 中创建词汇表？

这并不难。只需glossary在您的文档中添加一个指令，并在其中包含您的所有术语和定义。当然，您可以拥有多个词汇表（也许针对不同的受众），但基本上就是这样。请参阅https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#glossary-directive。

但问题比这更复杂。您正在尝试对glossary不受支持的指令执行某些操作。

没有术语和定义的词汇表是没有意义的。我在您的 reST 示例中看不到任何术语和定义。

您似乎想要某种由文档中的标记生成的索引。Sphinx可以自动生成带有页码的通用索引（我想你已经知道了）。有一个index指令，还有一个index用于定义索引条目的角色。但是由于您坚持为此使用词汇表，因此问题变得令人困惑，我仍然不确定我是否理解您想要的内容。

顺便说一句，请注意词汇表中定义的术语会显示在自动生成的索引中（请参阅在 Sphinx 中使用 noindex 和词汇表）。

继续前进，假设您有一个要编入索引的章节标题（标题）：

About this Guide
****************

使标题文本显示在生成的索引中的最简单方法是使用内联index角色，如下所示：

:index:`About this Guide`
*************************

您还可以使用块级index指令：

.. index:: About this Guide

About this Guide
****************

如果此答案不是您想要的，请澄清问题。

Answer 2

使用http://sphinx-doc.org/markup/misc.html#directive-index在书的末尾创建索引