/docs/README

 1The documentation in this tree is in plain text files and can be viewed using
 2any text file viewer.
 3
 4Technically speaking, it uses ReST (reStructuredText) [1], and the Sphinx
 5documentation system [2].  This allows it to be built into other forms for
 6easier viewing and browsing.
 7
 8To create an HTML version of the docs on a Unix machine (Linux or Mac):
 9
10* Install Sphinx (using ``easy_install Sphinx`` or some other method)
11
12* In this docs/ directory, type ``make html`` at a shell prompt.
13
14The documentation in _build/html/index.html can then be viewed in a web browser.
15
16[1] http://docutils.sourceforge.net/rst.html
17[2] http://sphinx.pocoo.org/