小能豆

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

py

我有一个公共的 GitHub 存储库。按照readthedocs 上的说明,我使用 Sphinx 以我希望其他人能够看到的形式获取文档。

编辑文件并重建,直到您满意为止,然后提交更改并推送到公共存储库。一旦您在公共存储库中拥有 Sphinx 文档,您就可以开始使用阅读文档。

我已将所有这些内容推送到我在 github 上的公共存储库。具体来说,我有一个docs.py和一个index.rst位于 内的文件docs,它是位于我项目顶层的文件夹。

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

几秒钟内,您的代码将自动从公共存储库中获取,并构建文档。

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

您可以在此处的readthedocs 中查看构建的输出。

可能相关的另一个细节是,我必须编辑conf.pygithub 上的文件,以便它知道主代码位于docs所在的目录中。

那么 - 我需要做哪些更改才能让 readthedocs 正确构建我的文档,更重要的是,我误解了什么?


阅读 20

收藏
2024-12-29

共1个答案

小能豆

对于 Pyramid,我们有一个setup.py,并将命令-e .[docs]放入名为 的文件中rtd.txt,这两个文件都位于项目的根级别。然后我们在高级设置下配置 RTD 以使用此文件:

  • 勾选“使用以下方式在虚拟环境中安装你的项目setup.py install
  • 输入您的需求文件的名称。

见截图。1.png

2024-12-29