Python第三方庫sphinx可以自動化為restful API生成文件，使用步驟如下所示：

• 1. 安裝

pip install sphinx

• 2. 建立文件目錄

mkdir document

• 3. 配置

配置方式有兩種：

1. 可以使用sphinx-quickstart命令配置，基本上一路按回車就可以，最後會生成一下檔案和目錄：

2. 使用sphinx-apidoc命令

可以用--help檢視引數列表

例如：

sphinx-apidoc -F -l -f --ext-autodoc -o ./ -H projectname -A Author ../app

其中../app為API原始碼目錄，根據自己情況設定，不過每執行一次都有重新修改conf.py的path路徑

3.修改conf.py

將工程目錄新增到模組搜尋路徑，生成文件時是需要。

import os
import sys
sys.path.insert(0, os.path.abspath(r'..'))

這段程式碼預設是註釋掉的，路徑設定工程目錄

• 4. 編譯

直接執行make會給出可以make的列表

生成html文件，可以執行make epub 或 make html

生成檔案在_build目錄, 兩種格式結構類似，但make html的格式有搜尋功能，本人比較喜歡。