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

Question

我有一个公共 github 存储库。在 readthedocs 上关注instructions，我使用 Sphinx 以一种我很乐意让其他人看到的形式获取文档。

编辑您的文件并重新构建，直到您喜欢所看到的为止，然后提交您的更改并推送到您的公共存储库。在公共存储库中拥有 Sphinx 文档后，您可以开始使用 Read the Docs。

我已将所有这些推送到我在 github 上的公共存储库。特别是，我在docs 中有一个docs.py 和一个index.rst 文件，这是一个位于我项目顶层的文件夹。

我在 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 配置为使用此文件，在 Advanced Settings 下：

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

见截图。