Paweł Zarębski 562a4824d7 [3.1.x] Fixed example of QuerySet.explain() with flags in docs.
Backport of 054ab1e00fe59a103b6b8ff29bc7930c7d492406 from master
2020-09-23 11:48:08 +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.