Python Sphinx、Kivy和autodoc:创建文档的警告和问题

Python Sphinx、Kivy和autodoc:创建文档的警告和问题,python,kivy,warnings,python-sphinx,Python,Kivy,Warnings,Python Sphinx,我想在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)

我想在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)
那么,如果我跑

生成干净的html&生成html

我有以下wanring(并且没有编辑文档..):

警告:/home/math/drphytoscan/source/autodoc.rst:4:(警告/2)autodoc:无法导入模块u'src.main';以下例外情况 已引发:回溯(最近一次调用last):文件 “/usr/local/lib/python2.7/dist-packages/sphinx/ext/autodoc.py”,第行 657,在导入对象中 导入(self.modname)文件“/home/math/drphytoscan/source/src/main.py”,第14行,从 kivy.app导入app导入错误:没有名为app的模块

注意:如果我删除该行:

from kivy.app import App
它起作用了。这表明它来自Kivy lib导入


PS:我在Debian Jessie上有Python 2.7.9、Kivy 1.9.1和Sphinx 1.6.3,它们来自于

为了让Sphinx(实际上是执行Sphinx的Python解释器)找到您的模块,它必须是可导入的。这意味着模块或包必须位于sys.path上的一个目录中–相应地调整配置文件中的sys.path


我检查了我的系统路径,看起来还可以。Sphinx位于/usr/local/lib/python2.7/dist-packages和kivy:/usr/lib/python2.7/dist-packages中。当我在python命令行shell上键入“sys.path”时,两者都存在。也许同一文档页上的警告会有所帮助?理想情况下,您可以将所有内容安装到虚拟环境中,并从其中调用Sphinx。@Steve Piercy-“理想情况下,您可以将所有内容安装到虚拟环境中…”在这里,我尝试为我的项目生成文档,Sphinx安装不在该项目的venv中,当然也找不到其他已安装的软件包。