django/docs
Timo Graham 127f1e4190 Fixed #15827 - Documented that OneToOneField in Profile should be named 'user'; thanks lawgon.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@16155 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2011-05-04 23:44:26 +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 Fixed #14262 -- Added new assignment_tag as a simple way to assign the result of a template tag to a context variable. Thanks, Julien Phalip. 2011-05-03 11:52:42 +00:00
internals Fixed #13729 -- Renamed UK localflavor to GB to correctly follow ISO 3166. Thanks, Claude Paroz. 2011-05-03 11:52:20 +00:00
intro
man
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 #15960 -- Extended list filer API added in r16144 slightly to pass the current model admin to the SimpleListFilter.lookups method to support finer grained control over what is filtered over. Many thanks to Carl Meyer and Julien Phalip for the suggestion and patch. 2011-05-04 22:52:04 +00:00
releases Fixed #14262 -- Added new assignment_tag as a simple way to assign the result of a template tag to a context variable. Thanks, Julien Phalip. 2011-05-03 11:52:42 +00:00
topics Fixed #15827 - Documented that OneToOneField in Profile should be named 'user'; thanks lawgon. 2011-05-04 23:44:26 +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/