django

History

Nicolas Ippolito b3ea37e304 [1.5.X] Typo in comments doc Backport of `17b14d4819` from master		2012-11-13 05:25:11 -05: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	[1.5.x] Documented minimal python 3.2 version.	2012-11-02 10:52:15 +01:00
howto	[1.5.x] Fixed #19208 -- Docs for mod_wsgi daemon mode	2012-10-29 21:40:10 +01:00
internals	[1.5.x] Added a note and link to CLA from contributing docs	2012-11-04 12:26:23 -08:00
intro	[1.5.X] Fixed #19216 - Switched to user level installation in apps tutorial.	2012-10-31 20:02:23 -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	Replaced mentions of Subversion by Git in docs	2012-10-14 23:03:01 +02:00
ref	[1.5.X] Typo in comments doc	2012-11-13 05:25:11 -05:00
releases	[1.5.x] Corrected a typo that inadvertently made its way into the docs. Backport of `0a49e6164c`.	2012-11-04 15:45:20 -08:00
topics	[1.5.X] Fixed #19161 - Added missing clean_password method in custom user docs	2012-11-06 19:46:40 -05:00
Makefile	[1.5.x] Fixed #19266 -- Added Texinfo documentation target	2012-11-09 09:03:52 +01:00
README	Fixed #18928 . Tightened language in docs/README.	2012-09-08 11:11:37 +05:30
conf.py	[1.5.x] Fixed #19266 -- Added Texinfo documentation target	2012-11-09 09:03:52 +01: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	[1.5.X] Fixed #16671 - Added a tutorial on reuseable apps	2012-10-30 18:41:29 -04:00
make.bat	[1.5.x] Fixed #19266 -- Added Texinfo documentation target	2012-11-09 09:03:52 +01: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/