django

History

Jannis Leidel 13b4f98b80 Fixed #6581 -- Moved documentation of django.contrib.auth.views.redirect_to_login to an own "Helper functions" section. git-svn-id: http://code.djangoproject.com/svn/django/trunk@16130 bcc190cf-cafb-0310-a4f2-bffc1f526a37		2011-04-30 13:37:03 +00:00
..
_ext	…
_theme/djangodocs	…
faq	…
howto	Fixed small typos in custom template tags docs.	2011-04-30 02:19:24 +00:00
internals	Updated the contributing document to accurately reflect our security process.	2011-04-17 14:13:19 +00:00
intro	…
man	…
misc	…
obsolete	Fixed #14141 : docs now use the :doc: construct for links between documents.	2010-08-19 19:27:44 +00:00
ref	…
releases	…
topics	…
Makefile	…
README	…
conf.py	…
contents.txt	Fixed #13397 - Include third level headings in the TOC. thanks cyang for the suggestion, rleland for the patch.	2010-12-27 23:58:16 +00:00
glossary.txt	Minor markup and organization fixes to docs to correct Sphinx errors.	2011-03-22 14:35:14 +00:00
index.txt	Changed e-mail to email throughout documentation and codebase. The one exception is translation strings, which I didn't want to disrupt	2011-04-01 16:10:22 +00:00

README

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

Technically speaking, 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 on a Unix machine (Linux or Mac):

* Install Sphinx (using ``easy_install Sphinx`` or some other method)

* In this docs/ directory, type ``make html`` 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/