2010-11-07 01:44:26 +08:00
|
|
|
The documentation in this tree is in plain text files and can be viewed using
|
|
|
|
|
any text file viewer.
|
|
|
|
|
|
2013-10-11 04:42:30 +08:00
|
|
|
It uses ReST (reStructuredText) [1], and the Sphinx documentation system [2].
|
2012-09-08 13:41:37 +08:00
|
|
|
This allows it to be built into other forms for easier viewing and browsing.
|
2010-11-07 01:44:26 +08:00
|
|
|
|
2012-03-03 17:11:54 +08:00
|
|
|
To create an HTML version of the docs:
|
2010-11-07 01:44:26 +08:00
|
|
|
|
2012-03-03 17:11:54 +08:00
|
|
|
* Install Sphinx (using ``sudo pip install Sphinx`` or some other method)
|
2010-11-07 01:44:26 +08:00
|
|
|
|
2011-07-19 17:00:24 +08:00
|
|
|
* In this docs/ directory, type ``make html`` (or ``make.bat html`` on
|
|
|
|
|
Windows) at a shell prompt.
|
2010-11-07 01:44:26 +08:00
|
|
|
|
|
|
|
|
The documentation in _build/html/index.html can then be viewed in a web browser.
|
|
|
|
|
|
|
|
|
|
[1] http://docutils.sourceforge.net/rst.html
|
2013-09-23 01:34:30 +08:00
|
|
|
[2] http://sphinx-doc.org/
|
