Timothy McCurrach 3d51e1635a [3.2.x] Fixed #32860 -- Made docs permalinks focusable to improve accessibility.
Backport of 4659a790cf5d0036c3c7488877b4365d948ccb01 from main
2021-06-21 14:07:27 +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.