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。