README 653 Bytes
Newer Older
1 2 3 4 5 6 7
The documentation in this tree is in plain text files and can be viewed using
any text file viewer.

Technically speaking, it uses ReST (reStructuredText) [1], and the Sphinx
documentation system [2].  This allows it to be built into other forms for
easier viewing and browsing.

8
To create an HTML version of the docs:
9

10
* Install Sphinx (using ``sudo pip install Sphinx`` or some other method)
11

12 13
* In this docs/ directory, type ``make html`` (or ``make.bat html`` on
  Windows) at a shell prompt.
14 15 16 17 18

The documentation in _build/html/index.html can then be viewed in a web browser.

[1] http://docutils.sourceforge.net/rst.html
[2] http://sphinx.pocoo.org/