indexing - 如何在 ReadTheDocs 导航栏中链接生成的索引页面？

Question

我正在使用他们的主题在 ReadTheDocs 上使用 Sphinx 创建我的文档。构建过程会生成一个 genindex.html 文件，可以通过以下方式引用:

Link to the :ref:`genindex` page.

这创造了:

Link to the Index page.

我无法添加 genindex到我的 toctree，例如像这样:

.. toctree:

   foo
   bar
   genindex

因为它是一个自动生成的文件，在渲染时不存在。此外，Sphinx 期望 genindex 是一个名为 genindex.rst 的本地文件。 .

如何将其添加到我的 ToC/导航中？

Answer 1

至于没有人发布更好的解决方案，我会写下我的解决方法作为一个有效的解决方案。

Sphinx 将索引创建为 denindex.html在构建根目录中。它不能在 toctree 中引用指令，因为该指令引用了 ReST 文件。那么如何解决呢？

所以让我们创建一个 genindex.rst文件并从 toctree 引用它指示。这也创建了一个 genindex.html在构建根目录中。所有链接都按预期创建。 genindex.html文件需要定义一个像“Index”这样的标题，作为导航栏中的链接标题。

从 ReST 文件写入所有 HTML 文件后，Sphinx 生成其索引并覆盖 genindex.html .

源文件:

源文件 index.rst :

.. toctree::
   :caption: Introduction

   chapter1
   chapter2

.. toctree::
   :caption: Main Documentation

   chapter3
   chapter4

.. toctree::
   :caption: Appendix

   genindex

源文件 genindex.rst :

.. This file is a placeholder and will be replaced

Index
#####

导航栏截图: