Python sphinx 如何确保Sphinx文档中生成的所有索引都已更正
我正在使用Sphinx为我的Django应用程序创建文档 为了帮助/加强文档中的信息,我在根文件夹/docs/和另一个文件夹/docs/modules/中添加了自己的源文件(Python sphinx 如何确保Sphinx文档中生成的所有索引都已更正,python-sphinx,Python Sphinx,我正在使用Sphinx为我的Django应用程序创建文档 为了帮助/加强文档中的信息,我在根文件夹/docs/和另一个文件夹/docs/modules/中添加了自己的源文件(.rst),如下所示: docs/ abc.rst <folders1, 2 ...> modules/ about.rst extra_folder/ xyz.rst quest.rst ...... 文档
.rst
),如下所示:
docs/
abc.rst
<folders1, 2 ...>
modules/
about.rst
extra_folder/
xyz.rst
quest.rst
......
文档/
abc.rst
模块/
关于rst
额外文件夹/
xyz.rst
探索rst
......
现在,我在终端使用makehtml
生成了文档,并创建了可以在浏览器中查看的文档。我可以在页面上看到指向我的.rst
文件的链接,也可以查看内容。使用搜索字段,我可以看到搜索键在文档中的任何位置都被正确搜索(包括我自己的.rst
文件)
然而,当我访问索引页面时,我发现:
- 没有指向我创建的页面的链接(例如,abc.rst),即显示的项目列表中缺少我自己的页面(如果我要单击A)
- 甚至连关键字母表都不见了。一个恰当的例子是,尽管我的源文件中有一个源文件quest.rst,并且已经包含在index.rst中(根据toctree指令),但字母表Q完全丢失了
我应该如何处理缺少索引的问题?您是指Sphinx自动生成的文件名为的文件吗?如果是,则这些是根据生成的索引项。请共享index.rst文件内容和至少一个缺少的文件。斯芬克斯报告了哪些错误/警告?@Paebbels-感谢您的写作。不知何故,我已经能够解决这个问题了。现在,指数的走势是正确的。方向来自您建议的页面。这是否回答了您的问题?你是说Sphinx自动生成的文件名为?如果是,则这些是根据生成的索引项。请共享index.rst文件内容和至少一个缺少的文件。斯芬克斯报告了哪些错误/警告?@Paebbels-感谢您的写作。不知何故,我已经能够解决这个问题了。现在,指数的走势是正确的。方向来自您建议的页面。这是否回答了您的问题?