Sphinx 是一種工具馁菜，它允許開發(fā)人員以純文本格式編寫文檔，以便采用滿足不同需求的格式輕松生成輸出。這在使用 Version Control System 追蹤變更時(shí)非常有用。純文本文檔對(duì)不同系統(tǒng)之間的協(xié)作者也非常有用。純文本是當(dāng)前可以采用的最便捷的格式之一毛肋。
雖然 Sphinx 是用 Python 編寫的，并且最初是為 Python 語言文檔而創(chuàng)建屋剑，但它并不一定是以語言為中心润匙，在某些情況下，甚至不是以程序員為中心唉匾。Sphinx 有許多用處孕讳，比如可以用它來編寫整本書！
可以將 Sphinx 想像成為一種文檔框架：它會(huì)抽象化比較單調(diào)的部分巍膘，并提供自動(dòng)函數(shù)來解決一些常見問題厂财，比如突出顯示標(biāo)題索引和特殊代碼（在顯示代碼示例時(shí)），以及突出顯示適當(dāng)?shù)恼Z法峡懈。
-----引自 使用 sphinx 制作簡(jiǎn)潔而又美觀的文檔
詳細(xì)的安裝和環(huán)境配置過程網(wǎng)上已經(jīng)有很詳細(xì)的介紹璃饱，自行搜索安裝即可。
-
安裝所有軟件后肪康，運(yùn)行以下命令：
cd: sphinx-quickstart -
打開index.rst文件荚恶，并中添加：
.. automodule:: run :members:這個(gè)是用于自動(dòng)從模塊讀取docstring的語句，可以自動(dòng)從run模塊讀取文檔磷支。
如下圖所示：
Image 1.png
-
修改conf.py文件
如果現(xiàn)在直接生成谒撼，會(huì)告訴你找不到run模塊，因?yàn)镾phinx默認(rèn)只會(huì)從sys.path里加載模塊雾狈，所以需要將demo目錄加入sys.path廓潜，所以現(xiàn)在打開conf.py，添加如下內(nèi)容：import os import sys sys.path.insert(0, os.path.abspath('../..')) -
運(yùn)行Sphinx生成html文檔
sphinx-build -b html source build make html
注意：
-
make html命令要切換到source所在文件夾的根目錄
- windows下切換到上一級(jí)目錄命令：cd..
- windows下切換到下一級(jí)目錄命令：cd 文件目錄名
-
rst格式文件和index.rst文件要放到source目錄中
最終生成的index.html文件善榛，即目錄跳轉(zhuǎn)頁如下：
Image 4.png
參考文檔：
