如何在 Sphinx 中创建自动单词列表答案

【问题标题】：How to create an automatic list of words in Sphinx如何在 Sphinx 中创建自动单词列表
【发布时间】：2017-08-31 07:49:10
【问题描述】：

我正在用 Sphinx 写一本书（与 Python 完全无关）。我有一些出现在文本中的术语，我想在 pdf 的末尾列出。我想要的正是 Latex 提供的index 所能达到的效果。

我知道 sphinx 中的 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 文档 here 中阅读了有关 index 角色的信息。似乎很适合我的问题，但不清楚最终如何创建所有术语的索引。

是否有命令列出使用创建的所有术语

.. index: mammal

整个文本？还是有其他指令可以完成工作？

【问题讨论】：

除了make <builder>，我不知道有什么命令可以运行。这是example output of the Sphinx docs using make html。 Sphinx 会自动为任何构建器生成索引。索引中的条目是根据域生成的，任何手动条目都在 reStructuredText 标记中，.. index:: <entries> 用于块，:index: 用于内联。
索引像在 LaTeX 中一样工作。 Sphinx 生成一个包含所有索引内容的单独 HTML 页面。您可以拥有简单、双重和三重索引条目。 Sphinx 将为您分组。这是example output。有些域会创建自己的索引。

标签： python-sphinx

【解决方案1】：

这些 cmets 足以让我弄清楚。

索引是在html中自动生成的，但是必须在文件genindex.html中找到，因为其他原因我的机器里隐藏了这个文件。

对于pdf 输出，索引必须单独编译。

所以，sphinx 中没有额外的命令，一切都是自动的。

【讨论】：

通常，索引是通过 HTML 页面链接链接的，但是在导航栏中链接索引有一个技巧。您需要创建一个genindex.rst，它可以在toctree 指令中列出。当编写导航并解析所有内容时，Sphinx 将使用索引数据库的输出覆盖 genindex.html。