Syntax 如何在Sphinx中创建词汇表?

Syntax 如何在Sphinx中创建词汇表?,syntax,python-sphinx,glossary,Syntax,Python Sphinx,Glossary,我试图在我的书的末尾制作一个词汇表,其中也包含我文档的标题内容(,没有描述,只参考了页面)。我想把标题编入词汇表。但标题需要两行字才能起作用,因为你必须在它们下面划线 因此,我正在寻找一种方法来组合。。词汇表::带有标题的命令,或使该命令在我的标题下不可见我不想看到。。词汇表::我的LaTeX PDF输出中的命令,因为如果我分离该命令,我将有两次标题。我只想看看词汇表 但每次我尝试这样做,我的标题就不再突出显示,也不起作用了 它们看起来就像一个。。注意::LaTeX PDF中的框和我的结构丢失

我试图在我的书的末尾制作一个词汇表,其中也包含我文档的标题内容(,没有描述,只参考了页面)。我想把标题编入词汇表。但标题需要两行字才能起作用,因为你必须在它们下面划线

因此,我正在寻找一种方法来组合
。。词汇表::
带有标题的命令,或使该命令在我的标题下不可见我不想看到
。。词汇表::
我的LaTeX PDF输出中的命令,因为如果我分离该命令,我将有两次标题。我只想看看词汇表

但每次我尝试这样做,我的标题就不再突出显示,也不起作用了

它们看起来就像一个
。。注意::
LaTeX PDF中的框和我的结构丢失

它看起来是什么样子:

它应该是什么样子:

此外,结构也不见了,因此关于本指南的内容不再是标题

外观:

它应该是什么样子:

我在网上搜索了很多,找到了很多关于
的描述。。词汇表::
语法,但不能与标题结合使用。所以我自己尝试了很多不同的方法。下面是一些附近无休止的示例XD,我是如何尝试的:

1.)

(二) …词汇表::

About this Guide
****************
我还在
下缩进了这部分代码。。词汇表::
命令来获取某种块或框,但我的标题不再高调,也不起作用

(三)

在这次尝试中,我的标题工作得很好,但是glossary命令在我的LaTeX PDF输出中可见,所以我使用了两次

有没有办法将我的标题与词汇表命令结合起来,或者使示例3中的separat glossary命令不可见?

用于在书的末尾创建索引

如何在Sphinx中创建词汇表

这并不难。只需在文档中添加一个
glossary
指令,并在其中包含所有术语和定义。当然,您可以有多个词汇表(可能针对不同的受众),但基本上就是这样。看

但问题比这更复杂。您正试图使用
glossary
指令执行不受支持的操作

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

您似乎需要某种由文档中的标记生成的索引。Sphinx可以自动生成带有页码的通用索引(我想你已经知道了)。有一个指令,也有一个用于定义索引项的角色。但既然你坚持使用词汇表,这个问题就变得令人困惑,我还不能完全确定我是否理解你的意思

顺便说一下,请注意术语表中定义的术语会显示在自动生成的索引中(请参阅)

接下来,假设您有一个要编制索引的节标题(标题):

About this Guide
****************
使标题文本显示在生成的索引中的最简单方法是使用内联角色,如下所示:

:index:`About this Guide`
*************************
也可以使用块级别指令:

.. index:: About this Guide

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

如果这个答案不是你想要的,请澄清这个问题。

我不明白你想做什么。术语表是术语及其解释的集合。您没有使用
glossary
指令,如中所述。@mzjn:Question edited!这里似乎有一些误解。Sphinx不会基于散布在整个文档中的多个
glossary
指令自动填充书背词汇表。这不是它的工作原理。如果您想在文档末尾添加一个术语表,请包含一个
glossary
指令,在该指令中您可以手动添加所有术语和定义。@mzjn:但是如果我将单个..glossary::commands扩展到整个文档,sphinx将集成到放置该命令的站点的链接。如果我把所有词汇表术语集中在一个命令中,我就失去了这种良好的自动化功能?!还是我错了?oO还将在您的文档中打印一个术语表命令,那么如何使用这些单行命令呢?在官方文档中,他们说我必须把这些命令放在标题的顶部才能正确链接!oO术语表命令将以LaTeX PDF格式打印出来,因此如何使用这个命令lineA glossary包含术语和定义。但在你的问题中的例子中,没有术语或定义。他们在哪里?很抱歉,我还是不明白你想要达到什么目的。我是否使用。。index::命令或。。glossary::command,因为它们都会破坏我的标题。同样的语法,同样的问题。我正在寻找一种方法,使一个框或东西(像某种div框)围绕标题,它的下划线,使它与我的命令。或一个单独的命令行,这将不会在打印输出中看到。然后我将使用..索引::命令从现在开始。那么,我唯一不明白的是:如果我不在整个文档中使用index命令,如何使交叉链接(自动链接)工作。(如果我把所有的都放在一行?)你告诉我这是可能的!那么线索是什么呢?PDF中没有按字母顺序排列的页码索引吗?或者问题出在其他地方?它是链接的,但指向我放置命令的位置,那么获取所有命令的线索是什么呢。。索引::在一个命令行中需要的项目?使用这种命令样式,我必须将其放在文档中的每个标题中!或者是否有可能在一个命令中获取所有项?顺便说一句,谢谢你的耐心XD。建议:用一个小而完整的例子提出一个新问题
:index:`About this Guide`
*************************
.. index:: About this Guide

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