Carlton Gibson d716d30a19 [3.2.x] Refs #32694 -- Clarified when colorama requirement is needed in Windows how-to.
Backport of 4f128fcf5dd5099a5ea374a87cad64852a9b62dd from main
2021-04-29 11:27:39 +02:00
..
2020-06-03 11:42:42 +02:00
2017-05-24 09:13:26 -04: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.