Question

在构建文档时，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'

Answer 1

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

Index
=====

在index.rst添加：

.. toctree::
   :hidden:

   genindex

如果您还希望网站上的链接和文字“索引”，而不仅仅是左侧导航，请删除:hidden: