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 设置成包含中文的路径，否则容易出现一些默名其妙的错误，例如编码错误。)