如何在 Sphinx TOC 中包含“genindex”？答案

【问题标题】：How can i include the `genindex` in a Sphinx TOC?如何在 Sphinx TOC 中包含“genindex”？
【发布时间】：2016-07-14 03:10:56
【问题描述】：

Sphinx 在构建文档时会生成一个名为 genindex 的索引，因此会生成一个名为 forbids to use that name for a document 的索引。现在，如何在目录中包含指向该索引的链接？

我试过了：

.. toctree::
   :maxdepth: 2

   genindex
   api


Indices and tables
==================

* :ref:`genindex`

虽然最后一行确实在文档中创建了指向该索引的链接，但构建在创建 TOC 时并不知道引用：

WARNING: toctree contains reference to nonexisting document 'genindex'

【问题讨论】：

同stackoverflow.com/q/25243482/407651
这能回答你的问题吗？ How can I link the generated index page in ReadTheDocs navigation bar?
你能解释一下方程式吗：4 years, 2 months > 4 years, 9 months@Paebbles？

【解决方案1】：

使用以下内容创建文件genindex.rst：

Index
=====

在你的index.rst 添加：

.. toctree::
   :hidden:

   genindex

如果您还想在网站上拥有链接和文本“索引”，而不仅仅是在左侧导航中，请删除 :hidden:

【讨论】：