Use Sphinx-build to create open source software documentation under WIN7

Recently want to look at Odoo's use of documents, online to see inconvenient, and have not provided offline document download, because it is open source project, this project is hosted on GitHub, so there is to go through GitHub to put the document git down, but git down the document is. rst file, not read properly. Look at the material and figure out that it needs to be converted to the required format by Sphinx.

I'm going to start my conversion process here.

1. Install Python2.7.10 (download and install Python for windows:https://www.python.org/downloads/windows/)

2, after the installation is complete, in the Python scripts directory, should be able to find Easy_install, under the CMD console to execute the command at the command line input Easy_install Sphinx

• • Note: Easy_install can automatically download and install the Sphinx and other modules it depends on.
  • 3. After the installation is complete, the command line prompts finished processing dependencies for Shinx
  • 4, in the command line input Sphinx-build--version, may be ejected sphinx-build is not internal or external commands. When you install Python, environment variables are not set. Add the environment variable, adding the scripts under the Python directory to the path of the environment variable. Execution Sphinx-build--version will have the relevant version information. Description Sphinx-build Available
  • 5. Under command line, CD to the document directory that needs to be converted, and run Sphinx-build trunk HTML
  • 6, wait a moment, will be in the current directory to generate an HTML folder. This is the HTML-formatted manual for this document.
  • Reference:
  • Http://www.cnblogs.com/huangjacky/archive/2012/07/15/2592671.html
  • Http://www.cnblogs.com/yanhuiw/p/3756085.html

Use Sphinx-build to create open source software documentation under WIN7