al-sabr / GradleFx-Documentation

The documentation of GradleFx in Sphinx format

GradleFx-Documentation

The documentation of GradleFx in Sphinx format

Installation

1. Download and install the latest 2.x release of Python: http://www.python.org/download/
2. Install setuptools
   1. download the ez_setup.py file (from http://pypi.python.org/pypi/setuptools#windows) for 64-bit Python installations and double click on it to execute it.
   2. add the PYTHON_HOME/Scripts directory to the PATH environment variable
3. Install Sphinx by executing the following command on the command line: easy_install -U Sphinx

Usage

Building the html documentation

Use the following command to build the html documentation. The result can be found in _build/html.

$ make html

Update the documentation version number

The version can be incremented by changing the ‘version’ and ‘release’ properties in the conf.py file. These two properties should have the same version number.