1
0
mirror of https://github.com/django/django.git synced 2025-04-12 11:32:20 +00:00
Ian Wootten 2026314b20 [4.1.x] Fixed #33804 -- Corrected GinIndex.gin_pending_list_limit description in docs.
Backport of 6f63e0ce8e36fbdb2d0c4dfd77ed3cf02e467f49 from main
2022-06-24 14:54:06 +02:00
..
2021-04-30 14:04:22 +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.

.. _ReST: https://docutils.sourceforge.io/rst.html
.. _Sphinx: https://www.sphinx-doc.org/