如何在 Sphinx TOC 中包含 `genindex`？

Question

Sphinx 在构建文档时会生成一个名为 genindex 的索引，因此会生成一个名为 forbids to use that name for a document 的索引。现在，我如何在 table 的内容中包含 link 到该索引？

我试过这个：

.. toctree::
   :maxdepth: 2

   genindex
   api


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

* :ref:`genindex`

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

WARNING: toctree contains reference to nonexisting document 'genindex'

Answer 1

创建一个包含以下内容的文件genindex.rst：

Index
=====

在你的 index.rst 添加：

.. toctree::
   :hidden:

   genindex

如果您还希望网站上有 Link 和文本“Index”，而不仅仅是在左侧导航中，请删除 :hidden:

How can i include the `genindex` in a Sphinx TOC?