python-sphinx - 如何在Sphinx TOC中包含`genindex`？

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'

最佳答案

创建具有以下内容的文件genindex.rst：

Index
=====

在您的index.rst中添加：

.. toctree::
   :hidden:

   genindex

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

关于python-sphinx - 如何在Sphinx TOC中包含`genindex`？，我们在Stack Overflow上找到一个类似的问题：https://stackoverflow.com/questions/36235578/