2010-11-06 18:44:26 +01:00
|
|
|
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.
|
|
|
|
|
|
2012-03-03 10:11:54 +01:00
|
|
|
To create an HTML version of the docs:
|
2010-11-06 18:44:26 +01:00
|
|
|
|
2012-03-03 10:11:54 +01:00
|
|
|
* Install Sphinx (using ``sudo pip install Sphinx`` or some other method)
|
2010-11-06 18:44:26 +01:00
|
|
|
|
2011-07-19 11:00:24 +02:00
|
|
|
* In this docs/ directory, type ``make html`` (or ``make.bat html`` on
|
|
|
|
|
Windows) at a shell prompt.
|
2010-11-06 18:44:26 +01:00
|
|
|
|
|
|
|
|
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/
|
