django

History

Tim Graham 2aaa467a2a Fixed #18057 - Documented that caches are not cleared after each test; thanks guettli for the suggestion.		2012-09-22 07:09:12 -04: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	Removed an obsolete documentation page about admin style customization.	2012-09-10 17:19:35 -07:00
howto	Fixed #18934 - Removed versionadded/changed annotations for Django 1.3	2012-09-20 19:06:55 -04:00
internals	Removed an excess colon. Thanks to jMyles for the patch.	2012-09-20 13:49:26 -07:00
intro	Removed an obsolete documentation page about admin style customization.	2012-09-10 17:19:35 -07: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 #18934 - Removed versionadded/changed annotations for Django 1.3	2012-09-20 19:06:55 -04:00
ref	Fixed #18951 -- Formatting of microseconds.	2012-09-22 12:02:21 +02:00
releases	Fixed #16218 -- date_list order in generic CBVs.	2012-09-22 11:47:34 +02:00
topics	Fixed #18057 - Documented that caches are not cleared after each test; thanks guettli for the suggestion.	2012-09-22 07:09:12 -04:00
Makefile	Added gettext target to sphinx makefiles.	2012-04-07 22:35:57 +00:00
README	Fixed #18928 . Tightened language in docs/README.	2012-09-08 11:11:37 +05:30
conf.py	Added latex preamble for ≤.	2012-08-28 22:45:51 +02:00
contents.txt	Removed an obsolete documentation page about admin style customization.	2012-09-10 17:19:35 -07:00
glossary.txt	Fixed #18451 -- Vastly improved class based view documentation.	2012-06-11 10:40:23 +02:00
index.txt	Removed a colloquialism ("and then some") from the documentation index page that would be confusing to non-native English speakers.	2012-09-10 17:27:50 -07: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.

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/