1
0
mirror of https://github.com/django/django.git synced 2025-04-22 16:24:40 +00:00
Abdullah Dursun 42f8c085a6 [3.1.x] Corrected note about long names in search docs.
Backport of fcad0b132427847d6db2008f00fbe45a7b45cad3 from master
2020-08-31 22:37:20 +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.

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