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)

然后，如果我跑

清理&&制作html

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

警告：/home/math/drphytoscan/source/autodoc.rst:4：（警告/2）autodoc：导入模块 u'src.main' 失败； 引发了以下异常：Traceback（最近调用最后一次）：文件“/usr/local/lib/python2.7/dist-packages/sphinx/ext/autodoc.py”，第 657 行，在 import_object import (self.modname ) 文件“/home/math/drphytoscan/source/src/main.py”，第 14 行，在 from kivy.app import App ImportError: No module named app

注意：如果我删除该行：

from kivy.app import App

有用。 这表明它来自 Kivy 库导入。

PS：我在 Debian Jessie 上安装了 Python 2.7.9、Kivy 1.9.1 和 Sphinx 1.6.3

Answer 1

从autodoc 文档顶部的注释：

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