django/docs
Russell Keith-Magee 1af33427cb Fixed #15623 -- Corrected province codes for Canadian localflavor. Thanks to shelldweller for the report.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@15864 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2011-03-17 00:59:30 +00:00
..
_ext
_theme/djangodocs
faq
howto Fixed #15598 -- Updated static URL helper to be no-op on non-local prefixes. Thanks, traff. 2011-03-15 20:13:21 +00:00
internals
intro Fixed #15257 - Add a link about field lookups to the tutorial; thanks dwillis. 2011-02-22 00:57:28 +00:00
man
misc
obsolete
ref Use Sphinx `:download:` directives for spatial database template creation scripts instead of linking to geodjango.org. 2011-03-16 16:21:16 +00:00
releases Fixed #15623 -- Corrected province codes for Canadian localflavor. Thanks to shelldweller for the report. 2011-03-17 00:59:30 +00:00
topics Fixed #15603 -- Changed the traceback error e-mails not to use HTML by default. It's now configurable with an 'include_html' parameter to AdminEmailHandler. Thanks, kmtracey 2011-03-16 04:13:57 +00:00
Makefile
README
conf.py
contents.txt
glossary.txt Fixed #14141: docs now use the :doc: construct for links between documents. 2010-08-19 19:27:44 +00:00
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/