django1/docs
Carlton Gibson 859d1d1cb0 [2.2.x] Added CVE-2019-14233 to security release archive.
Backport of 9600f63885 from master
2019-08-01 12:03:53 +02:00
..
_ext Fixed crash building translated docs since Sphinx 1.8. 2018-10-01 20:44:02 -04:00
_theme Refs #20910 -- Replaced snippet directive with code-block. 2018-09-10 13:00:34 -04:00
faq [2.2.x] Used extlinks for Django's source code. 2019-03-28 20:39:38 -04:00
howto [2.2.x] Updated WSGI servers ordering according to the more commonly used. 2019-07-16 14:44:29 +02:00
internals [2.2.x] Changed tuple choices to list in docs. 2019-05-15 14:41:01 +02:00
intro [2.2.x] Fixed explanation of how to automatically create tables in database. 2019-07-15 15:24:44 +02:00
man [2.2.x] Updated man page for Django 2.2. 2019-07-01 07:54:32 +02:00
misc Updated various links in docs to avoid redirects 2017-05-22 19:28:44 +02:00
ref [2.2.x] Refs #30083 -- Added a warning about performing queries in pre/post_init receivers. 2019-07-19 16:07:29 +02:00
releases [2.2.x] Added CVE-2019-14233 to security release archive. 2019-08-01 12:03:53 +02:00
topics [2.2.x] Fixed #30656 -- Added QuerySet.bulk_update() to the database optimization docs. 2019-07-29 10:10:00 +02: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] Used extlinks for Django's source code. 2019-03-28 20:39:38 -04: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 Removed dead links to botbot.me. 2018-11-10 17:25:10 -05:00
make.bat
spelling_wordlist Fixed #28990 -- Added autosummarize parameter to BrinIndex. 2018-08-02 11:26:58 -04: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/