django/docs
Claude Paroz 02b66f161f [1.5.x] Fixed #19191 -- Corrected a typo in CustomUser docs
Thanks spleeyah for the report.

Backport of 90c7656 from master.
2012-10-26 10:26:47 +02: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 #11460 - Added a FAQ regarding missing rows in the admin. 2012-09-27 17:36:02 -04:00
howto Fixed #17388 - Noted in the custom model field docs that field methods need to handle None if the field may be null. 2012-10-19 17:51:24 -04:00
internals [1.5.X] Fixed #19180 - Clarified policy regarding older versions of the docs. 2012-10-25 17:56:30 -04:00
intro [1.5.X] Fixed #19180 - Clarified policy regarding older versions of the docs. 2012-10-25 17:56:30 -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 Fixed #9471 - Expanded ModelAdmin.raw_id_fields docs; thanks adroffne for the suggestion. 2012-10-24 17:43:24 -04:00
releases Update docs/releases/1.5.txt 2012-10-25 14:50:34 -07:00
topics [1.5.x] Fixed #19191 -- Corrected a typo in CustomUser docs 2012-10-26 10:26:47 +02: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 [1.5.x] Sphinx conf to 1.5 alpha 1. 2012-10-25 14:30:53 -05: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 Fixed two broken links introduced in recent commits. 2012-09-27 17:33:52 -04: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/