Bug in 58b27e0dbb3d31ca1438790870b2b51ecdb10500. Backport of 7b94847e384b1a8c05a7d4c8778958c0290bdf9a 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.