1
0
mirror of https://github.com/django/django.git synced 2024-12-24 01:55:49 +00:00
django/docs
Andrew Badr 29cd3d6c01 Fix docs for context_processors.auth
Copy said it created three context variables, but only lists two. ("messages" was removed.)
2012-09-24 17:14:11 -07:00
..
_ext
_theme/djangodocs
faq Removed an obsolete documentation page about admin style customization. 2012-09-10 17:19:35 -07:00
howto Fixed #18934 - Removed versionadded/changed annotations for Django 1.3 2012-09-20 19:06:55 -04:00
internals Removed an excess colon. Thanks to jMyles for the patch. 2012-09-20 13:49:26 -07:00
intro Made a version condition less confusing. 2012-09-23 20:18:29 +02:00
man
misc Fixed #18934 - Removed versionadded/changed annotations for Django 1.3 2012-09-20 19:06:55 -04:00
ref Fix docs for context_processors.auth 2012-09-24 17:14:11 -07:00
releases Fixed #16218 -- date_list order in generic CBVs. 2012-09-22 11:47:34 +02:00
topics Fixed #14861 -- Moved logging config outside of Settings.__init__ 2012-09-24 22:12:45 +02:00
conf.py
contents.txt Removed an obsolete documentation page about admin style customization. 2012-09-10 17:19:35 -07:00
glossary.txt
index.txt Removed a colloquialism ("and then some") from the documentation index page that would be confusing to non-native English speakers. 2012-09-10 17:27:50 -07:00
make.bat
Makefile
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 ``sudo 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.pocoo.org/