django

History

Luke Plant bee498f3a2 Added 'format_html' utility for formatting HTML fragments safely		2012-07-03 22:20:12 +01:00
..
_ext	Made more extensive usage of context managers with open.	2012-05-05 14:06:36 +02: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 #17511 - Removed reference to deprecated "reset" management command in FAQ; thanks voxpuibr@ for the report.	2012-06-27 18:54:42 -04:00
howto	Replaced 'return' by 'raise' in custom model field docs	2012-07-02 10:16:42 +02:00
internals	Fixed #16519 -- Deprecated mimetype kwarg of HttpResponse __init__	2012-06-30 21:27:47 +02:00
intro	Fixed #18493 - Added instructions to locate the Django source files to the t	2012-07-01 06:55:46 -04:00
man	Fixed #18035 -- Removed deprecated AdminMediaHandler, as per official deprecation timeline. Thanks Jannis Leidel and Ramiro Morales for the review.	2012-04-08 21:13:32 +00:00
misc	Fixed #18451 -- Vastly improved class based view documentation.	2012-06-11 10:40:23 +02:00
obsolete	Fixed #14141 : docs now use the :doc: construct for links between documents.	2010-08-19 19:27:44 +00:00
ref	Added 'format_html' utility for formatting HTML fragments safely	2012-07-03 22:20:12 +01:00
releases	Fixed #16047 -- Restore autocommit state correctly on psycopg2	2012-07-01 19:36:43 +03:00
topics	Fixed #17168 - Noted TransactionMiddleware only works with "default" database alias.	2012-06-30 10:25:51 -04:00
Makefile	Added gettext target to sphinx makefiles.	2012-04-07 22:35:57 +00:00
README	Fixed #9995 -- Updated the installation instructions to recommend pip. Also fixed ReST errors. Refs #9112 .	2012-03-03 09:11:54 +00:00
conf.py	Fixed #18269 -- Applied unicode_literals for Python 3 compatibility.	2012-06-07 18:08:47 +02: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	Fixed #18451 -- Vastly improved class based view documentation.	2012-06-11 10:40:23 +02:00
index.txt	Fixed #18451 -- Vastly improved class based view documentation.	2012-06-11 10:40:23 +02:00
make.bat	Added gettext target to sphinx makefiles.	2012-04-07 22:35:57 +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:

* Install Sphinx (using ``sudo pip install Sphinx`` or some other method)

* In this docs/ directory, type ``make html`` (or ``make.bat html`` on
  Windows) 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/