pythonsphinx使用

Ⅰ 如何使用sphinx生成python第三方模塊的文檔

在使用Python的過程中，無疑我們經常需要下載安裝第三方模塊（如何安裝：URL），而安裝後我們必然會面臨一個使用的問題，這時候我們需要閱讀相關的文檔。可是我們會發現下載的第三方模塊目錄的doc文件夾下只有一個conf.py文件和一些後綴為rst的文件，文檔在哪裡呢？
其實Python提供了專用的文檔生成工具，有了這些工具就可以很方便地生成我們需要的文檔了。本文就是介紹如何使用一些第三方工具（sphinx）來生成這些文檔。
1.下載並安裝Docutils：http://docutils.sf.net/。
2.下載並安裝sphinx ：http://pypi.python.org/pypi/Sphinx/1.1。Sphinx 是用來生成文檔的，設計的初衷是為了生成python的文檔。可以生成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 設置成包含中文的路徑，否則容易出現一些默名其妙的錯誤，例如編碼錯誤。)