django/docs
Mariusz Felisiak 0b8a0296bf [3.1.x] Refs #33365, Refs #30530 -- Doc'd re_path() behavior change in Django 2.2.25, 3.1.14, and 3.2.10.
Follow up to d4dcd5b9dd.
Backport of 5de12a369a from main
2021-12-15 18:55:49 +01:00
..
_ext [3.1.x] Made default_role_error use logger. 2020-06-03 11:43:37 +02:00
_theme
faq [3.1.x] Changed IRC references to Libera.Chat. 2021-05-20 12:29:31 +02:00
howto [3.1.x] Updated links to DEPs. 2021-02-25 17:27:54 +01:00
internals [3.1.x] Refs #31676 -- Updated technical board description in organization docs. 2021-07-30 11:47:00 +02:00
intro [3.1.x] Changed IRC references to Libera.Chat. 2021-05-20 12:29:31 +02:00
man [3.1.x] Updated man page for Django 3.1 beta. 2020-06-15 09:52:09 +02:00
misc
ref [3.1.x] Refs #33365, Refs #30530 -- Doc'd re_path() behavior change in Django 2.2.25, 3.1.14, and 3.2.10. 2021-12-15 18:55:49 +01:00
releases [3.1.x] Added CVE-2021-44420 to security archive. 2021-12-07 08:55:21 +01:00
topics [3.1.x] Changed IRC references to Libera.Chat. 2021-05-20 12:29:31 +02:00
Makefile
README.rst Refs #25778 -- Updated sphinx-doc.org links to HTTPS. 2020-01-29 06:04:15 +01:00
conf.py [3.1.x] Refs #31676 -- Removed Django Core-Mentorship mailing list references in docs. 2021-07-13 20:24:38 +02:00
contents.txt
glossary.txt
index.txt Fixed #25712 -- Reorganized templates docs. 2020-04-30 08:12:09 +02:00
make.bat
spelling_wordlist [3.1.x] Added 'formatter' to spelling wordlist. 2021-10-12 15:17:36 +02:00

README.rst

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/