原文連結

使用pip進行安裝：

pip install sphinx

• 1

初始化

進入你程式碼所在的目錄,輸入:

sphinx-quickstart

• 1

下圖：PRD是程式碼所在目錄，生成的文件儲存目錄設成doc

下圖：設定專案名稱與作者，專案名稱之後會作為標題顯示在文件首頁

下圖：基本一路預設

下圖：到此，生成doc資料夾

配置修改

進入此資料夾找到conf.py檔案，開啟編輯,將下面幾行程式碼（第19-21行）取消註釋：

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

• 1
• 2
• 3

並修改程式碼為：

sys.path.insert(0, os.path.abspath('../..'))

• 1

生成 rst

到程式碼目錄,執行以下命令,會生成對應 python 檔名的 rst 檔案

sphinx-apidoc -o ./doc ./

• 1

生成 html

進入doc資料夾，執行make指令，生成html文件頁