python-sphinx - 如何确保在 Sphinx 文档中生成的所有索引都得到更正

Question

我正在使用Sphinx为我的 Django 应用程序创建文档。

为了帮助/加强文档中的信息，我添加了我自己的源文件 ( .rst)，它们都放在根文件夹/docs/和另一个文件夹/docs/modules/中，如下所示：

docs/
    abc.rst
    <folders1, 2 ...>
    modules/
        about.rst
        extra_folder/
        xyz.rst
        quest.rst
        ......

现在我make html在终端使用生成了文档，并且创建了可以在浏览器中查看的文档。我可以.rst在页面上看到指向我的文件的链接，也可以查看内容。使用搜索字段，我可以看到在文档中正确搜索了搜索键（包括我自己的.rst文件）。

但是，当我访问索引页面时，我发现：

• 没有指向我创建的页面的链接（例如abc.rst），即显示的项目列表中缺少我自己的页面（如果我要单击A）
• 连钥匙字母都不见了。一个典型的例子是，字母Q完全丢失了，尽管我的源文件中有一个源文件quest.rst并且已包含在index.rst中（在toctree指令下）。

我尝试了这个解决方案和这个解决方案。但是我无法生成缺少的索引。

我应该如何解决缺失索引的问题？

标签： python-sphinx