小编Mar*_*oux的帖子

我有一个托管在 Github 上的 Python 包，名为Spike2py。我已经使用 Sphinx 和 .rst 文件准备了我的文档。这些文件托管在 GitHub上。我能够make html在本地成功运行并获得所需的输出。也就是说，文档的参考指南部分包含使用我包含在代码中的文档字符串自动生成的 API，并使用对autoclass和autofunction( reference_guide.rst ) 的调用进行引用。

例如，当我在本地渲染时，参考指南的第一部分如下所示：

然而，当文档呈现在readthedocs（参见此处）上时，参考指南不包含提取的文档字符串；只是 .rst 文件中找到的标头。

预期行为

我希望 readthedocs 上呈现的文档与本地呈现的文档相同。然而，这并没有发生。

通过查看此处，我已确认当前版本的文档中的 readthedocs 上提供的版本。

但是，当我尝试下载文档的 PDF 或 HTML 版本时，参考指南不包含文档字符串。

其他信息

根据 readthedocs文档，本地构建不应推送到 GitHub；仅源文件。

这与这个问题有些相关，但我无法使建议的解决方案发挥作用。

更新 我遵循了 Steve Piercy 推荐的解决方案，这解决了部分问题。我添加了一个docs/requirements.txt文件以及一个.readthedocs.yml文件。

接下来我注意到构建使用的是 Python 3.7.9。鉴于我使用的是 Python >= 3.8 的类型提示，我必须在文件中指定 Python 的版本.readthedocs.yml。

然后我被 RTD 构建困住了，告诉我它找不到我的 index.rst 文件。 …