django1/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 Reformated some code for readability. 2010-11-20 21:00:41 +00:00
_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 #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 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 Fixed #14141: docs now use the :doc: construct for links between documents. 2010-08-19 19:27:44 +00:00
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 Fixed #13616 - Updated the documentation to be compatible with Sphinx 1.0. 2010-07-24 10:21:21 +00:00
README Added a README for building offline HTML docs. 2010-11-06 17:44:26 +00:00
conf.py Bumped django_next_version so that "New in Django 1.3" links appear correctly. 2011-03-24 09:40:50 +00:00
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/