Frantisek Holop a79d0c8c81 [3.1.x] Refs #31615 -- Improved creating extension docs.
Backport of f3ed42c8ad3757e7238bf2f326532f5b129aa102 from master
2020-05-27 11:14:31 +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.