django/docs
Mariusz Felisiak 2a04e24d2d [3.0.x] Added CVE-2021-28658 to security archive.
Backport of 1eac8468cb from main
2021-04-06 09:47:14 +02:00
..
_ext [3.0.x] Made default_role_error use logger. 2020-06-03 11:44:51 +02:00
_theme Refs #20910 -- Replaced snippet directive with code-block. 2018-09-10 13:00:34 -04:00
faq [3.0.x] Refs #31040 -- Doc'd Python 3.9 compatibility. 2020-10-13 08:40:39 +02:00
howto [3.0.x] Corrected custom model fields how-to. 2020-07-10 11:38:26 +02:00
internals [3.0.x] Skipped GetImageDimensionsTests.test_webp when WEBP is not installed. 2020-10-06 11:30:21 +02:00
intro [3.0.x] Updated How to install Django on Windows guide. 2020-06-03 16:29:30 +02:00
man [3.0.x] Updated man page for Django 3.0. 2020-05-04 07:13:43 +02:00
misc [3.0.x] Expanded API stability docs to include our policy of continual improvement. 2019-11-18 21:39:30 +01:00
ref [3.0.x] Fixed #32110 -- Doc'd and tested enumerations for ChoiceField.choices. 2020-10-17 21:06:57 +02:00
releases [3.0.x] Added CVE-2021-28658 to security archive. 2021-04-06 09:47:14 +02:00
topics [3.0.x] Corrected signing.dumps()/loads() signatures in docs. 2020-07-31 11:34:32 +02:00
Makefile Fixed docs build with Sphinx 1.6. 2017-05-24 09:13:26 -04:00
README [3.0.x] Refs #25778 -- Updated sphinx-doc.org links to HTTPS. 2020-01-29 06:06:23 +01:00
conf.py [3.0.x] Added documentation extlink for bugs.python.org. 2021-02-17 14:27:36 +01:00
contents.txt Fixed #26020 -- Normalized header stylings in docs. 2016-01-22 12:12:17 -05:00
glossary.txt Fixed #26020 -- Normalized header stylings in docs. 2016-01-22 12:12:17 -05:00
index.txt [3.0.x] Rewrote Get Help FAQ. 2020-03-26 10:25:24 +01:00
make.bat
spelling_wordlist [3.0.x] Fixed #31643 -- Changed virtualenv doc references to Python 3 venv. 2020-06-02 11:55:57 +02:00

README

The documentation in this tree is in plain text files and can be viewed using
any text file viewer.

It uses ReST (reStructuredText) [1], and the Sphinx documentation system [2].
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.

[1] http://docutils.sourceforge.net/rst.html
[2] https://www.sphinx-doc.org/