在使用Python、Django的過程中，經(jīng)常看到docs目錄，里面存放著一些txt文本文件，也就是自帶的一些幫助文檔，里面有make.bat，在dos目錄下直接執(zhí)行make，給出的幫助是可以轉(zhuǎn)換成Html、PDF等文件形式，那么，怎么轉(zhuǎn)換這些幫助文檔呢？直接執(zhí)行make html發(fā)現(xiàn)提示sphinx-build不是內(nèi)部或外部命令，在網(wǎng)上下載了Sphinx，并安裝，再次執(zhí)行make html時(shí)發(fā)現(xiàn)還是提示不是內(nèi)部或外部命令，最后發(fā)現(xiàn)，Sphinx安裝后，并沒有在Python安裝目錄中生成Sphinx的模塊，而是直接在Sphinx的源目錄下生成了一個(gè)build目錄，直接在當(dāng)前目錄中安裝了。

通過查找?guī)椭?#xff0c;直接早dos環(huán)境進(jìn)入sphinx源文件目錄，在此目錄下執(zhí)行如下命令：

python sphinx-build.py -b html 需要轉(zhuǎn)化文檔的全路徑 ?轉(zhuǎn)換后文檔的全路徑

例如：我的Sphinx源文件路徑在C:\Sphinx-1.3.1，Django的docs路徑在C:\Django-1.8\docs，現(xiàn)在將docs內(nèi)容轉(zhuǎn)換成html格式，并在docs中建立build目錄，轉(zhuǎn)換后的html存放目錄，執(zhí)行命令：

C:\Sphinx-1.3.1>python sphinx-build.py -b html C:\Django-1.8\docs?C:\Django-1.8\docs\build，執(zhí)行后，在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環(huán)境下，打開命令提示符，使用cd?/d?命令將當(dāng)前目錄切換至Sphinx目錄，運(yùn)行命令：python?sphinx-build.py?-b?html?sourcedir?builddir，其中，-b后面的字符串用于控制輸出文檔的格式，默認(rèn)為html。sourcedir表示文檔來源文件夾（一般就是包含conf.py文件的那個(gè)文件夾），builddir表示生成文檔的目標(biāo)文件夾。(注：在Windows環(huán)境下，請(qǐng)不要將sphinx文件夾、sourcedir?和builddir?設(shè)置成包含中文的路徑，否則容易出現(xiàn)一些默名其妙的錯(cuò)誤，例如編碼錯(cuò)誤。)

轉(zhuǎn)載于:https://www.cnblogs.com/ListenWind/p/4422640.html

總結(jié)

以上是生活随笔為你收集整理的Sphinx编译docs文档的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。