Generate open source documents using Sphinx under Windows7 (original)

The author here takes the Osgearth document as an example, feeling this way of generating the document is better, the generated HTML document is to support the search, thanks to the dedication of open source workers. Likes a

1. Download and install Python for windows:https://www.python.org/downloads/windows/

2. Download and install setup tools to download easy_stall.py and run Https://pypi.python.org/pypi/setuptools#windows-7-or-graphical-install, You can find the Windows 7

3. After the installation is complete, in the Python scripts directory, you should be able to find Easy_install, and execute the command at the command line at Easy_install Sphinx

• • Easy_install can automatically download and install Sphinx and other modules it relies on.

4. After the installation is complete, the command line prompts finished processing dependencies for Shinx

5. At the command line input sphinx-build, if the environment variable is not set when Python is installed, sphinx-build may not be internal or external command.  

6. Add the environment variable, adding the scripts under the Python directory to the path of the environment variable. There will be information about the execution. The important thing is that Sphinx-build is available.

7. Find the downloaded Docs document directory, as shown in, build I added, default only a few other files and folders

8. Open the console program and CD to the directory. Executes make HTML.

9. Then wait ...

10. Then under the Build/html folder, you can see the HTML file you want to see, open the Index.html

Attached: How to make your own documentation can be found in 3,

Reference Documentation:

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/