调用 sphinx-build生成HTML文件

安装 Sphinx

$ easy_install sphinx
Searching for sphinx
Reading http://pypi.python.org/simple/sphinx/
Reading http://sphinx.pocoo.org/
Best match: Sphinx 1.0.5
Downloading http://pypi.python.org/packages/[...]
Processing Sphinx-1.0.5-py2.5.egg
[...]
Finished processing dependencies for sphinx

 

脚本 sphinx-build 用来建立Sphinx文档集. 调用方式:

$ sphinx-build [options] sourcedir builddir [filenames]

 

调用示例：

$ sphinx-build -b html /home/ccx/user_docs/source/ /var/www/html/user_docs

 

sourcedir 是源文件目录 source directory , builddir 是生成文件目录.一般不需要写 filenames .

脚本 sphinx-build 的选项:

-b 生成器名字

生成器,决定了生成文档的类型,是最重要的选项. 通用的生成器有:

html

生成HTML文档. 默认的生成器.