找不到构建失败Sphinx错误content.rst

时间:2019-05-28 06:32:56

标签: read-the-docs

我按照阅读文档中的说明进行操作,但出现此错误:

  

bash Sphinx错误:主文件   /home/docs/checkouts/readthedocs.org/user_builds/mybinders/checkouts/latest/docs/source/contents.rst   找不到

您是否需要阅读docs yaml文件?

2 个答案:

答案 0 :(得分:1)

如果您有自己的conf.py文件,它将覆盖“读取文档”的默认conf.py。默认情况下,Sphinx期望主文档为contents。阅读文档会改为将主文档设置为index(或您在设置中指定的任何内容)。尝试将其添加到您的conf.py

master_doc = 'index'

有关更多信息,请查看以下问题:https://github.com/rtfd/readthedocs.org/issues/2569

答案 1 :(得分:0)

由于我使用的扩展名,我需要拥有conf.py,因此只需添加

master_doc = 'contents'

到您的conf.py,然后

将您的index.rst重命名为contents.rst

在构建通过OK之后,您仍然看不到ReadTheDocs上的任何内容,除了“此页面仍然不存在”外,请转到:

https://your-project.readthedocs.io/en/latest/contents.html

然后您将在其中看到您的文档。