Sphinx 環(huán)境搭建

配置環(huán)境：

1. 安裝

使用 pip install Sphinx 安裝，如果國(guó)內(nèi)站點(diǎn)訪問(wèn)比較慢，請(qǐng)使用鏡像站點(diǎn)下載，可通過(guò)下面的命令行安裝：

pip install Sphinx -i http://mirrors.tuna.tsinghua.edu.cn/

安裝完成后，可在 Python/Scripts/ 目錄下看到以下程序：<p>

1. sphinx-quickstart.exe <p>
2. sphinx-build.exe <p>

2. 配置程序路徑

參照 Python2/3共存的方法，可在對(duì)應(yīng)的 Python 文件夾中執(zhí)行如下操作

1. 建立空白文本文檔并重命名為 sphx_qs.bat ( .bat 前名稱(chēng)可自定義)，在此文件中添加下行：<p> Python 安裝路徑\Scripts\sphinx-quickstart.exe %*

2. 建立空白文本文檔并重命名為 sphx_bd.bat 在此文件中加入
   Python安裝路徑\Scripts\sphinx-build.exe %*

3.配置文檔

在文檔的根目錄下，運(yùn)行控制臺(tái)程序，輸入步驟2中配好的 sphinx-quickstart 對(duì)應(yīng)的.bat文件名，執(zhí)行 sphinx-quickstart 程序后，會(huì)生成如下文件：

• Makefile:構(gòu)建配置文檔
• conf.py 控制 Sphinx 讀取源文件生成目標(biāo)文檔的配置文件。
• index.rst 索引文件

4.生成HTML文件

在控制臺(tái)輸入 sphx_bd -b html 源目錄 文件生成目錄，可生成對(duì)應(yīng)的的 html 文檔。

5. 更多配置請(qǐng)參考