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。

对于Pyramid，我们有setup.py，并将命令-e .[docs]放入名为rtd.txt的文件中，两者都位于项目的根级别。然后我们在高级设置：

下配置RTD以使用此文件

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

查看屏幕截图。