作者這里以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/