Sphinx編譯docs文檔

在使用Python、Django的過程當中，常常看到docs目錄，裏面存放着一些txt文本文件，也就是自帶的一些幫助文檔，裏面有make.bat，在dos目錄下直接執行make，給出的幫助是能夠轉換成Html、PDF等文件形式，那麼，怎麼轉換這些幫助文檔呢？直接執行make html發現提示sphinx-build不是內部或外部命令，在網上下載了Sphinx，並安裝，再次執行make html時發現仍是提示不是內部或外部命令，最後發現，Sphinx安裝後，並無在Python安裝目錄中生成Sphinx的模塊，而是直接在Sphinx的源目錄下生成了一個build目錄，直接在當前目錄中安裝了。

經過查找幫助，直接早dos環境進入sphinx源文件目錄，在此目錄下執行以下命令：

python sphinx-build.py -b html 須要轉化文檔的全路徑  轉換後文檔的全路徑

例如：個人Sphinx源文件路徑在C:\Sphinx-1.3.1，Django的docs路徑在C:\Django-1.8\docs，如今將docs內容轉換成html格式，並在docs中創建build目錄，轉換後的html存放目錄，執行命令：

C:\Sphinx-1.3.1>python sphinx-build.py -b html C:\Django-1.8\docs C:\Django-1.8\docs\build，執行後，在build目錄生成了django的幫助文檔（Html格式的）。

下列是須要安裝的第三方工具：

1.下載並安裝Docutils：http://docutils.sf.net/。

2.下載並安裝sphinx ：http://pypi.python.org/pypi/Sphinx/1.1。

Sphinx 是用來生成文檔的，能夠生成html、htmlhelp/chm、qthelp、devhelp、latex、man 等格式的文檔。

3.在Widnows環境下，打開命令提示符，使用cd /d 命令將當前目錄切換至Sphinx目錄，運行命令：python sphinx-build.py -b html sourcedir builddir，其中，-b後面的字符串用於控制輸出文檔的格式，默認爲html。sourcedir表示文檔來源文件夾（通常就是包含conf.py文件的那個文件夾），builddir表示生成文檔的目標文件夾。(注：在Windows環境下，請不要將sphinx文件夾、sourcedir 和builddir 設置成包含中文的路徑，不然容易出現一些默名其妙的錯誤，例如編碼錯誤。)