2012-01-25 18 views
3
import myModule as myModule 

與此代碼導入,我可以讓我的文檔如何導入模塊,獅身人面像

import myPackage.myModule as myModule 

這個我得到「無模塊命名myPackage.myModule」 並不重要,如果這個文件存在根目錄或myPackage目錄中。

in RST-File我還沒有提及myModule,我想記錄其他文件,只是導入這個模塊。

回答

9

獅身人面像需要能夠導入你的代碼,爲類和函數生成文檔。您可能需要將您項目的根文件夾添加到Sphinx中的sys.path中。您可以從獅身人面像conf.py文件做到這一點:

import sys 
import os 
sys.path.append(os.path.join(os.path.dirname(__file__), '..')) 

替換'..'與該項目的根目錄的相對路徑。

+0

如果我的項目根目錄是兩個目錄,而不只是一個? – Dave

+0

@Dave然後用'../ ..'代替'..' –

+0

@AlexMorega您的代碼真的有幫助!我只是想編輯你的代碼來添加右括號,但我的編輯只有一個字符,所以它不會讓我。 – Will