readthedocs 和 PyQt5 上的自动文档

Question

我正在编写一个包装 PyQt5 功能的包，并尝试将文档放在 readthedocs 上。由于 PyQt5 是一个扩展模块，我模拟了模块及其类（手动，因为使用 unittest.mock 会导致元类冲突）：

class PyQt5:
    class QtCore:
        @staticmethod
        def qVersion():
            return '5.0.0'
        class QObject:
            pass
    # etc
sys.modules['PyQt5'] = PyQt5

这在本地运行良好。但是，尽管构建在 readthedocs 上没有错误通过，但没有自动文档输出。我错过了什么？

BitBucket 上的项目：https://bitbucket.org/fraca7/qtypy/

在 ReadTheDocs 上：https://readthedocs.org/projects/qtypy/

Answer 1

尽管它“通过”了构建，但如果您仔细查看您的 logs，您会在它开始调用 sphinx 时看到类似 ImportError: No module named 'qtypy' 的错误。

当我过去成功完成此操作时，我总是在存储库的顶层有一个 setup.py 文件用于安装包，我相信这是 readthedocs 可以安装包的唯一方法。

然后我在 readthedocs 项目管理员 -> 高级设置上启用了，

使用 setup.py install 在 vi​​rtualenv 中安装您的项目

这确保你的模块在 sphinx 运行时可以被导入，以便它可以自动生成文档（前提是你已经成功模拟了 PyQt5）。