readthedocs和PyQt5上的autodoc

时间:2018-01-20 13:58:04

标签: python-3.x pyqt5 read-the-docs

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

Z

这在本地工作正常。但是虽然构建在readthedocs上没有错误地传递,但是没有autodoc输出。我错过了什么?

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

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

1 个答案:

答案 0 :(得分:0)

尽管它“传递”了构建,如果你仔细查看logs,当它开始调用sphinx时,你会看到ImportError: No module named 'qtypy'之类的错误。

当我过去成功完成此操作时,我总是在存储库顶层有一个setup.py文件来安装软件包,我认为这是readthedocs安装软件包的唯一方法。封装

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

  

使用setup.py install“

在virtualenv中安装项目

这确保您的模块可以在sphinx运行时导入,以便它可以自动生成文档(前提是您已成功模拟PyQt5)。