django

History

Luke Plant b5da093fa9 In CSRF docs, moved 'Exceptions' section to 'Edge cases', and cleaned up some associated markup git-svn-id: http://code.djangoproject.com/svn/django/trunk@16188 bcc190cf-cafb-0310-a4f2-bffc1f526a37		2011-05-09 18:27:45 +00:00
..
_ext	…
_theme/djangodocs	…
faq	Fixed #14091 - be more correct about logging queries in connection.queries.	2011-04-22 12:14:54 +00:00
howto	Added missing reference to custom template tag docs.	2011-05-07 16:58:52 +00:00
internals	Fixed typo in deprecation docs.	2011-05-05 20:49:35 +00:00
intro	…
man	Fixed #7735 -- Added support for IPv6 adresses to runserver and testserver management command. Thanks to Jason Alonso and Łukasz Rekucki for the report and initial patches.	2010-11-26 13:33:53 +00:00
misc	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
obsolete	…
ref	In CSRF docs, moved 'Exceptions' section to 'Edge cases', and cleaned up some associated markup	2011-05-09 18:27:45 +00:00
releases	Fixed #15954 - New IGNORABLE_404_URLS setting that allows more powerful filtering of 404s to ignore	2011-05-05 20:49:26 +00:00
topics	Added TestCase.settings context manager to easily override settings in test methods.	2011-05-06 13:29:24 +00:00
Makefile	…
README	…
conf.py	…
contents.txt	…
glossary.txt	…
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/