假設我們已經存在了乙個專案名為doc_test，專案下存在乙個src資料夾，裡面存放我們的源**。
安裝sphinx
pip install sphinx建立文件生成的資料夾
建立乙個名為doc的資料夾，用來存放生成文件的指令碼及文件儲存。
生成文件配置及執行指令碼
在doc資料夾下執行如下操作：
sphinx-quickstart
... 接下來會出現下面的配置，可根據自己的專案情況填寫
> separate source and build directories (y/n)
[n]: y
> project name: test
> author name(s): fcat
> project release [
]: 1.0.0
> project language [en]: zh-cn
修改配置檔案
為了讓能夠支援文件自動生成還需要對doc/source/conf.py進行修改
生成rst檔案
命令列切換到doc目錄下，執行如下命令：
sphinx-apidoc -o ./source ../src/生成文件的html
命令列保持在doc目錄下，執行如下命令：
make html文件的自動生成
結構圖顯示時，可看到兩類格式的標題，即內建標題樣式 標題1 至標題9 或大綱級別段落格式 級別 1 到級別 9 使用 文件結構圖不但可以方便地了解文件的層次結構，還可以快速定位 長文件，大大加快閱讀的時間。文件結構圖將在乙個單獨的窗格中顯示文件標題。可通過文件結 構圖在整個文件中快速漫遊並追蹤特定位...
API文件自動生成
1 安裝coreapi pip install coreapi 2 在路由配置文件鏈結 from rest framework.documentation import include docs urls urlpatterns path docs include docs urls title 站...
API文件自動生成
1 安裝coreapi pip install coreapi 2 在路由配置文件鏈結 from rest framework.documentation import include docs urls urlpatterns path docs include docs urls title 站...