django/docs
Russell Keith-Magee e3d322ede8 Fixed #15177 -- Added note to generic views reference page indicating that the views have been deprecated (mirroring the topic guide). Thanks to rasca for the report and patch.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@15367 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2011-01-30 13:33:53 +00:00
..
_ext
_theme/djangodocs
faq
howto Refs #14661 -- Clarified the handling of initial data injected via custom SQL. 2011-01-18 16:43:01 +00:00
internals Fixed #13662 -- Added an entry in the README to direct people to the instructions for running the test suite, and cleaned up that section of the docs. Thanks to mir for the report, and to cogat and gg for the draft text. 2011-01-27 03:14:49 +00:00
intro Fixed #15153 - removed obsolete sentence in tutorial; thanks LeSphinx for the report. 2011-01-26 00:58:41 +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
obsolete
ref Fixed #15177 -- Added note to generic views reference page indicating that the views have been deprecated (mirroring the topic guide). Thanks to rasca for the report and patch. 2011-01-30 13:33:53 +00:00
releases Added note to 1.2.5 release notes about ModelAdmin.lookup_allowed change 2011-01-28 15:47:40 +00:00
topics Fixed #15134 -- Removed a duplicate TOC entry for modelforms docs. Thanks to Aryeh Leib Taurog for the report. 2011-01-30 13:33:27 +00:00
Makefile
README
conf.py Removed compatibility with Sphinx < 1.0 workarounds in our extension code. Also, started to use the 'needs_sphinx' Sphinx config var. 2010-11-19 23:19:56 +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/