django/docs
Gabriel Hurley 28123d7153 Fixed #15492 -- Documented the `invalid_date` and `invalid_time` error keys for !SplitDateTimeField. Thanks to lode for the report.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@15663 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2011-02-27 21:16:58 +00:00
..
_ext
_theme/djangodocs
faq Fixed #10904 -- Corrected inappropriate usage of the term "absolute URL" throughout the docs. Replaced with the (RFC 2396-compliant) terms "absolute path reference" or "absolute path" as appropriate for the context. Thanks to sharan666 for the report, and Malcolm, Chris, and dwillis for their work in supplying a solution and patch. 2010-11-07 01:42:55 +00:00
howto Fix typo in staticfiles docs (not ticketed). 2011-02-27 11:54:03 +00:00
internals Fixed #14401 -- Added a contributing howto guide for new users. Thank you to everyone who added their advice, feedback, and wisdom to the wiki article while constructing this new guide. 2011-02-25 02:45:48 +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
misc
obsolete Fixed #14141: docs now use the :doc: construct for links between documents. 2010-08-19 19:27:44 +00:00
ref Fixed #15492 -- Documented the `invalid_date` and `invalid_time` error keys for !SplitDateTimeField. Thanks to lode for the report. 2011-02-27 21:16:58 +00:00
releases Fixed #15299 -- Started the process of migrating the auth context processor support classes into the auth context processor module. Thanks to shailesh for the report, and v1v3kn for the draft patch. 2011-02-23 13:36:58 +00:00
topics Fixed #15509 -- corrected a typo in the cache docs. Thanks Paul. 2011-02-26 08:49:05 +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 Fixed #15196 -- Bumped version up a bit in Sphinx configuration. Thanks, Eric Holscher. 2011-01-30 20:31:39 +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
index.txt Fixed #6181 - Document `django.views.decorators.http` - thanks adamv for the patch. 2010-12-27 13:27:26 +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/