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

Question

我想在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)

那么，如果我跑

澄清

我有以下wanring（并且没有编辑文档..）：

警告：/home/math/drphytoscan/source/autodoc。rst:4：（警告/2）autodoc:无法导入模块u'src。主要'；引发了以下异常：Traceback（最近一次调用）：文件“/usr/local/lib/python2.7/dist packages/sphinx/ext/autodoc.py”，第657行，导入对象导入（self.modname）文件“/home/math/drphytoscan/source/src/main.py”，第14行，来自kivy。应用程序导入应用程序导入错误：没有名为app的模块

注意：如果我删除该行：

from kivy.app import App

它起作用了。这表明它来自Kivy lib导入。

PS：我在Debian Jessie上有Python 2.7.9，Kivy 1.9.1和Sphinx 1.6.3

Answer 1

从autodoc文档顶部的注释中：

为了让Sphinx（实际上是执行Sphinx的Python解释器）找到您的模块，它必须是可导入的。这意味着模块或包必须位于sys上的一个目录中。路径–调整您的系统。配置文件中相应的路径。