Claude Paroz 06474e929f [3.1.x] Refs #30165 -- Removed leftover 'u' prefix.
Backport of bac5777bff8e8d8189193438b5af52f158a3f2a4 from master
2020-07-29 10:20:08 +02:00
..
2017-05-24 09:13:26 -04:00
2020-07-14 21:05:55 +02:00

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 (or make.bat html on Windows) at a shell prompt.

The documentation in _build/html/index.html can then be viewed in a web browser.