Python sphinx 如何在Sphinx中创建自动单词列表
我正在用Sphinx写一本书(与python无关)。我有一些出现在文本中的术语,我想在pdf的末尾列出。我想要的正是Latex提供的功能所能实现的 我知道sphinx中的Python sphinx 如何在Sphinx中创建自动单词列表,python-sphinx,Python Sphinx,我正在用Sphinx写一本书(与python无关)。我有一些出现在文本中的术语,我想在pdf的末尾列出。我想要的正是Latex提供的功能所能实现的 我知道sphinx中的glossary指令,但它显然没有实现我想要的功能。例如,一些术语甚至没有定义,但我希望在文档末尾有一个指向它们的链接。大概是这样的: At page 1: Mammal is a type of animal, we all love them... At page 17: Berries are fruits,
glossary
指令,但它显然没有实现我想要的功能。例如,一些术语甚至没有定义,但我希望在文档末尾有一个指向它们的链接。大概是这样的:
At page 1:
Mammal is a type of animal, we all love them...
At page 17:
Berries are fruits, we all love them...
At the end of the book:
Index
berry, 17
mammal, 1
我已经阅读了sphinx文档中的索引角色。
对于我的问题,它似乎是完美的,但不清楚最终如何创建所有术语的索引
是否有命令列出使用创建的所有术语
.. index: mammal
贯穿全文?还是有其他指令可以完成这项工作?这些评论足以让我理解
索引是用html自动生成的,但必须在文件genindex.html
中找到,该文件由于其他原因隐藏在我的机器中
对于pdf
输出,必须单独编译索引
因此,sphinx中没有额外的命令,一切都是自动的。除了make
之外,我不知道还有什么命令可以运行。这是一个例子。Sphinx会自动为任何生成器生成索引。索引中的条目是根据域和重构文本标记中的任何手动条目生成的。。索引:
用于块,而:索引:
用于内联。索引的工作方式与LaTeX中的类似。Sphinx生成一个包含所有索引内容的单独HTML页面。您可以有简单索引项、双索引项和三索引项。斯芬克斯会帮你分组。这是一个例子。有些域会创建自己的索引。通常,索引是通过HTML页面链接链接的,但是在导航栏中链接索引有一个技巧。您需要创建一个genindex.rst
,它可以列在目录树
指令中。编写导航并解析所有内容后,Sphinx将使用索引数据库的输出覆盖genindex.html。