README 682 B

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