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	Fixed #13616 - Updated the documentation to be compatible with Sphinx 1.0.	2010-07-24 10:21:21 +00:00
faq	Fixed #14091 - be more correct about logging queries in connection.queries.	2011-04-22 12:14:54 +00:00
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	Fixed #15257 - Add a link about field lookups to the tutorial; thanks dwillis.	2011-02-22 00:57:28 +00:00
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	Fixed #15713 -- Added a form field for validating Polish National ID Card numbers. Thanks, xtrqt.	2011-04-28 13:20:33 +00:00
releases	Fixed #15920 -- Removed COMMENTS_BANNED_USERS_GROUP setting in favor of the established comments app customization. Thanks, Daniel Lindsley.	2011-04-29 15:11:17 +00:00
topics	Fixed #6581 -- Moved documentation of django.contrib.auth.views.redirect_to_login to an own "Helper functions" section.	2011-04-30 13:37:03 +00:00
Makefile	…
README	Added a README for building offline HTML docs.	2010-11-06 17:44:26 +00:00
conf.py	…
contents.txt	…
glossary.txt	…
index.txt	…

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/