django/docs
Sylvain Bellemare 9d23c3d03d [1.5.x] Fixed typo -- "a" user, not "an" user
Backport of c7dabe49dd from master
2013-11-01 19:29:15 -04:00
..
_ext [1.5.x] Added a bugfix in docutils 0.11 -- docs will now build properly. 2013-07-31 09:26:23 -04:00
_theme/djangodocs [1.5.x] Fixed #21702 -- Added different bullet styles for nested lists. 2013-09-23 07:40:07 -04:00
faq [1.5.x] Fixed #15379 - Added "how to cite Django" to FAQ. 2013-03-29 16:50:33 -04:00
howto [1.5.x] Fixed #20962 -- Documented that template tag render() may raise exceptions. 2013-10-14 11:55:15 -04:00
internals [1.5.X] Fixed wording in unit tests documentation. 2013-09-25 18:32:07 +02:00
intro [1.5.x] Fixed #21210 -- Documented when runserver doesn't auto-restart. 2013-10-14 10:38:34 -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 [1.5.X] Fixed #19728 - Updated API stability doc to reflect current meaning of "stable". 2013-02-19 18:20:46 -05:00
ref [1.5.x] Fixed #21364 -- Specified InnoDB full-text support from MySQL 5.6.4 on 2013-11-01 11:02:48 +01:00
releases [1.5.x] Fixed #21337 -- Documented removal of django.core.servers.basehttp.WSGIServerException 2013-10-30 07:48:16 -04:00
topics [1.5.x] Fixed typo -- "a" user, not "an" user 2013-11-01 19:29:15 -04:00
Makefile [1.5.x] Allowed overriding variables in docs/Makefile. 2013-07-29 06:52:50 -04:00
README Fixed #18928. Tightened language in docs/README. 2012-09-08 11:11:37 +05:30
conf.py [1.5.x] Bump everything for 1.5.5 bugfix release. 2013-10-24 23:31:51 -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 [1.5.x] Fixed #21180 -- Additional deprecation notes for databrowse. 2013-10-01 10:21:04 -04:00
make.bat [1.5.x] Fixed #19516 - Fixed remaining broken links. 2013-01-02 18:50:00 -05: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/