git - autodoc 指令在本地有效，但不适用于 readthedocs

我的仓库位于 github 上:https://github.com/AshleySetter/optoanalysis

文档在 https://github.com/AshleySetter/optoanalysis/tree/master/optoanalysis/docs 中

ReadTheDocs 不会失败，但生成的文档(托管在此处: https://optoanalysis.readthedocs.io/en/latest/ )不显示应该由 ..autodoc:: 命令生成的文档字符串。

但是，它在本地运行良好，并在我打开 build/html/index.html 文件时显示文档。

在 ReadTheDocs 上，它看起来像:



而本地构建的 html 文件如下所示:



为什么会这样？

最佳答案

您有用 Cython 编写并编译为 C 的模块。我认为 ReadTheDocs doesn't support C extensions 。您必须保护要在 ReadTheDocs 中生成的导入。

类似 this 的东西:

import os
if 'READTHEDOCS' not in os.environ:
    import cython_generated_ext

关于git - autodoc 指令在本地有效，但不适用于 readthedocs，我们在Stack Overflow上找到一个类似的问题：https://stackoverflow.com/questions/44989408/