autodoc指令在本地工作，但不在readthedocs上工作

Question

我的仓库位于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文件如下所示：

为什么会这样？

Answer 1

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

像this：

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