readthedocs不从公共github存储库创建文档

Question

我有一个公共github存储库。在readthedocs之后的instructions之后，我使用Sphinx以一种我很高兴让其他人看到的形式获取文档。

编辑你的文件并重建，直到你喜欢你所看到的，然后提交你的改变并推送到你的公共存储库。一旦您将Sphinx文档存储在公共存储库中，您就可以开始使用“读取文档”。

我已经把所有这一切都推送到我在github上的公共存储库。特别是，我有一个docs.py和一个index.rst文件坐在docs，这是一个文件夹坐在我的项目的顶层。

我在readthedocs上创建了我的帐户。我已经告诉readthedocs在哪里可以找到版本库。我现在期望

在几秒钟内，您的代码将自动从您的公共存储库中获取，并且将生成文档。

相反，readthedocs似乎构建它，但是当我去看它时，那里什么也没有。该网页存在，但它没有任何文档。构建在我的计算机上的相同文件显示文档。

您可以在readthedocs here上看到构建的输出。

可能相关的一个细节是，我在github上编辑conf.py文件，以便它知道主要的代码是在docs坐在目录

所以 - 什么，我需要更改为获取readthedocs以正确构建我的文档，更重要的是，我误解了什么？

Answer 1

RTD无法找到您的模块导入的模块。通过扩展第四项来查看错误：https://readthedocs.org/projects/epidemicsonnetworks/builds/5247491/

因此，无论您在本地如何构建文档，都无法在RTD上完成，直到您配置RTD以查找模块为止。有一个FAQ that covers this issue。

对于金字塔，我们有一个setup.py，并将命令-e .[docs]放到名为rtd.txt的文件中，这两个文件都位于项目的根目录。然后，我们配置RTD使用此文件，在高级设置：

• 勾选“安装项目中使用setup.py install一个的virtualenv内部”
• 输入您需求的文件的名称。

查看截图。