我想在Sphinx中创建我的代码文档 . 我安装了一切并做了一些简单的试用,运行正常 . (我运行sphinx-quickstart,编辑conf.py以包含模块的路径,使用教程来了解sphinx如何工作等等)
然而,我的代码导入了许多kivy库 . 当我想在导入kivy的模块上创建文档时,它会失败 .
例如,如果我有这样的main.py:
#!/usr/bin/python
# -*- coding: utf-8 -*-
from kivy.app import App
def test_app(a,b):
""" Test documentation """
print a + b
if __name__ == '__main__':
test_app(1,2)
然后,如果我跑
make clean && make html
我有以下wanring(并没有编辑文档..):
警告:/home/math/drphytoscan/source/autodoc.rst:4:(警告/ 2)autodoc:无法导入模块u'src.main';引发了以下异常:Traceback(最近一次调用最后一次):import_object import中的文件“/usr/local/lib/python2.7/dist-packages/sphinx/ext/autodoc.py”,第657行(self.modname )文件“/home/math/drphytoscan/source/src/main.py”,第14行,来自kivy.app import App ImportError:没有名为app的模块
注意:如果我删除该行:
from kivy.app import App
有用 . 这表明它来自kivy lib导入 .
你知道这是什么问题吗?你可以帮帮我吗?
先感谢您!
M.
PS:我在Debian Jessie上有python 2.7.9,kivy 1.9.1和Sphinx 1.6.3
1 回答
从documentation for autodoc顶部的注释: