blob: 323e191cce57bf9f4aa917ebed01f6f9c00ef477 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
|
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`` (or ``make.bat html`` on
Windows) 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/
|
