Windows7下使用sphinx生成开源文档（原）

作者这里以osgearth文档为例，感觉这种生成文档的方式比较好，生成的html文档是支持搜索的，感谢开源工作者的奉献。赞一个

1. 下载并安装python for windows：https://www.python.org/downloads/windows/

2.下载安装setup tools下载easy_stall.py 并运行https://pypi.python.org/pypi/setuptools#windows-7-or-graphical-install，可以找到windows 7的下载地址

3.安装完成后，在python的scripts目录下，应该可以找到easy_install,在控制台下执行该命令在命令行输入easy_install sphinx

• • 　　easy_install可以自动下载并安装sphinx以及它所依赖的其他模块。

4.安装完成后，命令行会提示Finished Processing dependencies for shinx

5.在命令行输入sphinx-build,如果在安装python时，没有设置环境变量，可能会弹出sphinx-build不是内部或者外部命令。

6.添加环境变量，将python目录下的scripts加入到环境变量的path中。再次执行会有相关信息。不用管这些，重要的是sphinx-build可用

7.找到下载的docs文档目录，如下图所示，build是我自己添加了，默认只有其他几个文件及文件夹

8.打开控制台程序，cd到该目录下。执行make html。

9.然后等待。。。

10.然后在build/html文件夹下，可以看到你想看到的html文件，打开index.html

附：怎么制作自己的文档可以参见^3,

参考文档：

1.http://www.cnblogs.com/Lvkun/archive/2010/04/01/1702245.html

2.http://ericscottbarr.com/blog/2012/03/sphinx-and-cmake-beautiful-documentation-for-c-projects/

3.http://avnpc.com/pages/writing-best-documentation-by-sphinx-github-readthedocs

4.http://www.ibm.com/developerworks/cn/opensource/os-sphinx-documentation/

5.http://www.pythondoc.com/sphinx/