2016-01-08 64 views
2

通過耦合教程和文檔, 包括主文檔here。繼它的去了,創建了兩個文件:無法使用,以產生文檔apiDocjs

1)example.js

var currentUser={ 
name='Mary' 
}; 
/** 
* @api {get} /user/ Request User information 
* @apiName GetUser 
* @apiGroup User 
*/ 

function getUser(){ 
return {code 200,data:currentUser}; 
} 
function setName(name){ 
    if(name.length==0){ 
     return {code:404,message:'NameEmptyError'}; 
    } 
currentUser.name=name; 
return {code 204}; 
} 

2)testpython .py

""" 
@api {get} /user/ Request User information 
@apiName GetUser 
@apiGroup User 
""" 
print "hello" 

將它們都保存在一個文件夾中,比如說「my_project」。 在mac終端上,進入「my_project」的父目錄。 運行腳本:

apidoc -i my_project/ -o apidoc/ 

四處錯誤:

- ERROR - Failed to parse sources 

這是基本的,但不知何故,沒有獲得成功。

回答

3

從npm和pip3安裝軟件包時會出現這種情況。完全清除當前安裝的apiDoc軟件包。 要刪除NPM包,去終端和類型:

cd /usr/local/lib/node_modules 

然後將其卸載,類型:

sudo npm uninstall apidoc 

這將刪除NPM-apidoc包。 要刪除PIP 3包:

sudo pip3 uninstall apidoc 

要手動刪除它們,去:

/usr/local/lib/pythonVERSION/dist-packages 

現在對於全新安裝:

sudo npm install apidoc -g 

這應該這樣做:)。