/docs/README
#! | 17 lines | 11 code | 6 blank | 0 comment | 0 complexity | b2bdd0e6b4c3764dcd3da212596c7ec7 MD5 | raw file
Possible License(s): BSD-3-Clause
- 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.
- To create an HTML version of the docs on a Unix machine (Linux or Mac):
- * Install Sphinx (using ``easy_install Sphinx`` or some other method)
- * In this docs/ directory, type ``make html`` at a shell prompt.
- 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/