1
0
mirror of https://github.com/django/django.git synced 2025-04-22 08:14:37 +00:00
Mariusz Felisiak 18e87ac85f [3.1.x] Refs #31863 -- Added release notes for 94ea79be137f3cb30949bf82198e96e094f2650d.
Backport of 21768a99f47ee73a2f93405151550ef7c3d9c8a2 from master
2020-08-13 16:30:37 +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/