如何在Sphinx的conf.py文件中使用python函數

Question

我已經寫了一個名爲myFunction的小函數，存儲在function.py中，我想在conf.py文件中調用它。這個函數在測試python文件中調用時工作正常，所以我似乎在導入這個文件中的模塊時會遇到問題。

的設置是這樣的：

DocumentSourceFolder/sourcefile.txt

DocumentSourceFolder/conf.py

DocumentSourceFolder/function.py

在conf.py我已經添加了以下：

import function

variable = function.myFunction()

（其中變量是conf.py文件中已存在的內容）。

當這個文件上運行的獅身人面像，不過，我收到錯誤：

ImportError: No module named function

任何想法？

感謝

Answer 1

事實證明，在conf.py文件中導入python模塊時，Sphinx有點挑剔。爲了避免錯誤，你需要做2步：

1） 添加到您conf.py文件

import sys, os 
sys.path.append(os.path.relpath('relative/path/to/folder/containing/module')) 

這意味着獅身人面像現在看起來這裏擴展模塊。然後，您必須將模塊名稱添加到extensions = [...]列表中。

2） 添加到您模塊以下：

def setup(app): 
    return 

這個「設置（）函數」的獅身人面像接受你的模塊確實是一個擴展模塊是必需的。

完成！

Answer 2

嘗試：

from function import function 

。

隨着：

import function 

的Python嘗試導入的模塊;你的文件顯然不是。 請參閱http://docs.python.org/2/tutorial/modules.html#more-on-modules中的小節