19

genindexSphinx在构建文档时生成一个名为的索引，因此禁止使用该名称作为文档。现在，如何在目录中包含指向该索引的链接？

我试过这个：

.. toctree::
   :maxdepth: 2

   genindex
   api


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

* :ref:`genindex`

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

WARNING: toctree contains reference to nonexisting document 'genindex'
4

1 回答 1

7

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

Index
=====

在您的index.rst添加中：

.. toctree::
   :hidden:

   genindex

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

于 2017-02-18T03:39:34.793 回答