Bug in 3b3f38b3b09b0f2373e51406ecb8c9c45d36aebc. Thanks Kevin Renskers for the report. Backport of 4a910f3de35338df7d4fcd8b7729fd1e31edaad0 from main
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.