django

History

Daniel Jilg eed658d7c4 Refs #14131 -- Documented why paginating large QuerySets may be slow.		2016-04-06 11:06:38 -04:00
..
_ext	…
_theme	Fixed many spelling mistakes in code, comments, and docs.	2015-12-03 12:48:24 -05:00
faq	…
howto	Fixed #24016 -- Added documentation about third-party app data migrations	2016-04-03 17:20:35 +02:00
internals	Fixed #26448 -- Added details for running tests with a different database backend.	2016-04-05 21:34:26 -04:00
intro	Fixed #26448 -- Added details for running tests with a different database backend.	2016-04-05 21:34:26 -04:00
man	…
misc	Fixed #26020 -- Normalized header stylings in docs.	2016-01-22 12:12:17 -05:00
ref	Fixed #26201 -- Documented the consequences of rotating the CSRF token on login.	2016-04-05 11:02:38 -04:00
releases	Fixed #25850 -- Made migrate/makemigrations error on inconsistent history.	2016-04-05 08:52:08 -04:00
topics	Refs #14131 -- Documented why paginating large QuerySets may be slow.	2016-04-06 11:06:38 -04:00
Makefile	…
README	Removed sudo from pip commands in docs.	2014-09-22 15:49:48 -04:00
conf.py	…
contents.txt	…
glossary.txt	…
index.txt	…
make.bat	…
spelling_wordlist	Added 'prefetches to docs/spelling_wordlist.	2016-02-26 16:06:34 -05: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/