django/docs
Daniel Izquierdo 030ef4d1af [1.5.x] Fixed #20654 -- Fixed type of `m2m_changed`'s `pk_set` arg in docs
Backport of 9a2b07f1b4 from master
2013-06-25 07:52:15 -04:00
..
_ext [1.5.x] Fixed spelling errors 2013-03-29 08:00:24 -04:00
_theme/djangodocs [1.5.x] Addeded CSS to bold deprecation notices. 2013-01-09 19:05:00 -05:00
faq [1.5.x] Fixed #15379 - Added "how to cite Django" to FAQ. 2013-03-29 16:50:33 -04:00
howto Fixed #20634 - Corrected doc mistake re: staticfiles finders strategy. 2013-06-21 15:00:06 -04:00
internals [1.5.x] Tweaked unit test 'quick start' explanation. 2013-05-20 13:49:11 -04:00
intro [1.5.x] Fixed error in last commit. Thanks Simon Charette. 2013-06-20 10:43:41 -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 #20654 -- Fixed type of `m2m_changed`'s `pk_set` arg in docs 2013-06-25 07:52:15 -04:00
releases [1.5.x] Warned that `request_finished` isn't sent by some buggy setups. 2013-06-12 20:57:21 +02:00
topics [1.5.x] Clarified get_list_or_404 docs, refs #14150. 2013-06-24 07:03:29 -04:00
Makefile [1.5.x] Allow build of translated documentation 2013-06-08 16:14:45 +02:00
README Fixed #18928. Tightened language in docs/README. 2012-09-08 11:11:37 +05:30
conf.py [1.5.x] Allow build of translated documentation 2013-06-08 16:14:45 +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 [1.5.x] Fixed #19897 - Updated static files howto. 2013-03-30 07:12:37 -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/