Follow up to 71c4fb7beb8e3293243140e4bd74e53989196440. Backport of 1d6fdca557e674b9a789b51caadca8985e588492 from master
The documentation in this tree is in plain text files and can be viewed using any text file viewer.
It uses ReST (reStructuredText), and the Sphinx documentation system. This allows it to be built into other forms for easier viewing and browsing.
To create an HTML version of the docs:
- Install Sphinx (using
python -m pip install Sphinx
or some other method). - In this docs/ directory, type
make html
(ormake.bat html
on Windows) at a shell prompt.
The documentation in _build/html/index.html
can then be
viewed in a web browser.