1
0
mirror of https://github.com/django/django.git synced 2025-01-11 10:56:28 +00:00
django/docs
2011-01-20 00:33:32 +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 Corrected an outdated reference to cmemcache in contributing docs. 2011-01-19 20:37:58 +00:00
intro Fixed #15057 - documented change in [14992] 2011-01-13 13:47:21 +00:00
man
misc
obsolete
ref Fixed #14672 - Added admin handling for on_delete=PROTECT. Thanks to jtiai for the report. 2011-01-20 00:33:32 +00:00
releases Refs #14661 -- Clarified the handling of initial data injected via custom SQL. 2011-01-18 16:43:01 +00:00
topics Corrected an outdated reference to cmemcache in contributing docs. 2011-01-19 20:37:58 +00:00
conf.py
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
Makefile
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/