關於 sphinx 的介紹描述
1,Sphinx是一個可以用於Python的自動文檔生成工具,可以自動的把docstring轉換為文檔
2,sphinx支持多種輸出格式包括html,latex,pdf等
# 安裝 sphinx yum install python-sphinx pip install -U sphinx # sphinx 自帶了一個執行腳本 sphinx-quickstart # -b 表示創建一個構建器 第一個目錄是源目錄(Sphinx項目的所有源文件) 第二個指的是文檔存儲目錄 此命令相當於 make html 只不過不再是build之中生成了 sphinx-build -b html /home/admin/bulit/source/ /home/admin/bulit/test # 生成 html 頁面 在 build 目錄之下 # make.bat Makefile 同級下執行 此命令 make html
source 下編寫輸出格式 在 .rst 文件之下編寫
1, exmple.rst 定義了列表 超鏈接 以及 表格 書寫形式
2, exmple1.rst 定義了函數 api輸出格式!
3, exmple2.rst 定義了 標題類型 圖片鏈接 json 數據輸出 table表格 api-url
build 是自動生成的!
可以參考我的githup
https://github.com/shiqilouyang/sphinx_doc