如何在Sphinx中创建词汇表?

问题描述 投票:6回答:2

我试着在我的书的最后写一个词汇表,其中也包含我的文档的标题内容(没有描述,只有对页面的引用)。我希望将头条新闻纳入词汇表。但是头条新闻需要2行,因为你必须强调它们。

因此,我正在寻找一种方法将.. glossary::命令与标题OR结合起来,使命令在我的标题下不可见。我不想在我的LaTeX PDF输出中看到.. glossary::命令,因为如果我分开命令,我会有两次头条新闻。我只想看术语表。

但每次我尝试,我的头条新闻不再突出显示,不工作。

它们看起来像是LaTeX PDF中的.. note::盒子,我的结构缺失了。

看起来如何:

应该如何看待:

结构也缺失了,所以关于本指南不再是标题。

看起来如何:

应该如何看待:

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

1.)

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

2.)..glossary ::

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

我还在.. glossary::命令下缩进了这部分代码以获得某种块或盒子,但我的头条新闻不再高调而且不起作用。

3.)

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

.. glossary:: About this Guide

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

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

syntax python-sphinx glossary
2个回答
6
投票

如何在Sphinx中创建词汇表?

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

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

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

您似乎想要某种索引,由文档中的标记生成。并且Sphinx可以自动生成包含页码的常规索引(我想你已经知道了)。有一个index指令,还有一个用于定义索引条目的index角色。但由于你坚持使用词汇表,这个问题变得令人困惑,我仍然不能完全确定我理解你想要什么。

顺便说一下,请注意词汇表中定义的术语会显示在自动生成的索引中(请参阅Using noindex with glossary in Sphinx)。

继续,我们假设您有一个要编制索引的节标题(标题):

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

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

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

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

.. index:: About this Guide

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

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


0
投票

使用http://sphinx-doc.org/markup/misc.html#directive-index在你书的最后创建一个索引

© www.soinside.com 2019 - 2024. All rights reserved.