django1/docs
Mariusz Felisiak 2a62cdcfec [2.2.x] Added CVE-2022-28346 and CVE-2022-28347 to security archive.
Backport of 78eeff8d33 from main
2022-04-11 10:37:53 +02:00
..
_ext [2.2.x] Fixed crash building HTML docs since Sphinx 4.3. 2021-11-18 13:33:29 +01:00
_theme Refs #20910 -- Replaced snippet directive with code-block. 2018-09-10 13:00:34 -04:00
faq [2.2.x] Changed IRC references to Libera.Chat. 2021-05-20 12:42:48 +02:00
howto [2.2.x] Fixed #30999 -- Fixed typo in docs/howto/custom-template-tags.txt. 2019-11-19 10:09:55 +01:00
internals [2.2.x] Refs #31676 -- Updated technical board description in organization docs. 2021-07-30 11:53:15 +02:00
intro [2.2.x] Changed IRC references to Libera.Chat. 2021-05-20 12:42:48 +02:00
man [2.2.x] Updated man page for Django 2.2. 2019-11-04 08:44:55 +01:00
misc [2.2.x] Expanded API stability docs to include our policy of continual improvement. 2019-11-18 21:40:22 +01:00
ref [2.2.x] Fixed CVE-2022-22818 -- Fixed possible XSS via {% debug %} template tag. 2022-02-01 07:56:29 +01:00
releases [2.2.x] Added CVE-2022-28346 and CVE-2022-28347 to security archive. 2022-04-11 10:37:53 +02:00
topics [2.2.x] Fixed CVE-2021-45115 -- Prevented DoS vector in UserAttributeSimilarityValidator. 2022-01-04 10:20:31 +01:00
Makefile Fixed docs build with Sphinx 1.6. 2017-05-24 09:13:26 -04:00
README Removed sudo from pip commands in docs. 2014-09-22 15:49:48 -04:00
conf.py [2.2.x] Added requirements.txt to files ignored by Sphinx builds. 2021-11-30 12:12:07 +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 [2.2.x] Changed IRC references to Libera.Chat. 2021-05-20 12:42:48 +02:00
make.bat Fixed #19516 - Fixed remaining broken links. 2013-01-02 18:32:57 -05:00
requirements.txt [2.2.x] Refs #33247 -- Corrected configuration for Read The Docs. 2021-11-03 19:05:19 +01:00
spelling_wordlist [2.2.x] Added 'formatter' to spelling wordlist. 2021-10-12 15:18:17 +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 ``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] http://sphinx-doc.org/