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.
|
|
|
|
|
|
2020-01-09 14:10:28 +01:00
|
|
|
It uses `ReST`_ (reStructuredText), and the `Sphinx`_ documentation system.
|
2012-09-08 07:41:37 +02:00
|
|
|
This allows it to be built into other forms for easier viewing and browsing.
|
2010-11-06 18:44:26 +01:00
|
|
|
|
2012-03-03 10:11:54 +01:00
|
|
|
To create an HTML version of the docs:
|
2010-11-06 18:44:26 +01:00
|
|
|
|
2019-04-14 17:02:36 +02:00
|
|
|
* Install Sphinx (using ``python -m 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
|
|
|
|
2020-01-09 14:10:28 +01:00
|
|
|
The documentation in ``_build/html/index.html`` can then be viewed in a web
|
|
|
|
|
browser.
|
2010-11-06 18:44:26 +01:00
|
|
|
|
2020-01-09 14:10:28 +01:00
|
|
|
.. _ReST: https://docutils.sourceforge.io/rst.html
|
2020-01-29 06:04:15 +01:00
|
|
|
.. _Sphinx: https://www.sphinx-doc.org/
|
