readthedocs 没有正确生成索引页

Question

Index.rst 个文件看起来像这样。

Modules
==========

Contents:

.. toctree::
   :maxdepth: 1

   ping
   rpc

我在与 index.rst 相同的目录中有 ping.rst 和 rpc.rst。正在正确创建用于 ping 和 rpc 的 html 页面，但索引 html 没有正确的数据。

问题似乎在于此

docs/rpc.rst: WARNING: document isn't included in any toctree
docs/ping.rst: WARNING: document isn't included in any toctree

我检查过，生成的文件夹 _build/html/_sources/ 有意外行为。 rpc.rst.txt 和 ping.rst.txt 与 rpc.rst 和 ping.rst 相同，但 index.rst.txt 为空白。

对 sphinx 命令使用 -vvvvv 时，发现以下输出。

writing output... [ 33%] index
[app] emitting event: 'doctree-resolved'(<document: >, 'index')
[app] emitting event: 'html-page-context'('index', 'page.html', {'file_suffix': '.html', 'style': 'bootstrap-sphinx.css', 'master_doc': 'inde
writing output... [ 50%] ping
[app] emitting event: 'doctree-resolved'(<document: <target...><section "ping"...>>, 'ping')
[app] emitting event: 'html-page-context'('ping', 'page.html', {'file_suffix': '.html', 'style': 'bootstrap-sphinx.css', 'master_doc': 'index

我错过了什么？

Answer 1

删除对 nsible2rst.main() 的调用。此调用似乎覆盖了其他自动化。

readthedocs 没有正确生成索引页

readthedocs not generating index page properly

python-sphinx

read-the-docs