django/docs
Tim Graham de95867284 [1.6.x] Fixed #21353 -- Noted that description is ignored for TabularInlines.
Thanks nofinator for the report.

Backport of d5031ecf88 from master
2014-04-10 13:33:34 -04:00
..
_ext [1.6.x] Fixed #21869 -- Fixed docs building with Sphinx 1.2.1. 2014-01-24 09:05:49 -05:00
_theme/djangodocs [1.6.x] Fixed #21558 -- Support building CHM files. 2013-12-04 16:51:37 +01:00
faq [1.6.x] Added Python 3.4 support notes. 2014-03-27 08:14:39 -04:00
howto [1.6.x] Fixed #22412 -- More nuanced advice re template filters and exceptions. 2014-04-10 06:19:15 -04:00
internals [1.6.x] Small doc changes missed in 66076268. 2014-03-21 22:11:50 +01:00
intro [1.6.x] Fixed some typos in the documentation. 2014-03-02 17:21:10 +01:00
man Revert "Patch by Claude for #16084." 2013-01-25 13:58:37 -03:00
misc [1.6.x] Fixed #21213 -- Added docs for Django's mailing lists. 2013-12-19 09:24:13 -05:00
ref [1.6.x] Fixed #21353 -- Noted that description is ignored for TabularInlines. 2014-04-10 13:33:34 -04:00
releases [1.6.x] Fixed #22364 -- Sanitized getpass input in changepassword. 2014-04-10 13:16:08 -04:00
topics [1.6.x] Fixed #22343 -- Disallowed select_for_update in autocommit mode 2014-04-10 02:15:14 +03:00
Makefile [1.6.x] Allowed overriding variables in docs/Makefile. 2013-07-29 06:52:42 -04:00
README Fixed #18928. Tightened language in docs/README. 2012-09-08 11:11:37 +05:30
conf.py [1.6.x] Fixed #21213 -- Added docs for Django's mailing lists. 2013-12-19 09:24:13 -05:00
contents.txt Removed an obsolete documentation page about admin style customization. 2012-09-10 17:19:35 -07:00
glossary.txt [1.6.x] Fixed some typos in the documentation. 2014-03-02 17:21:10 +01:00
index.txt [1.6.x] Fixed #21213 -- Added docs for Django's mailing lists. 2013-12-19 09:24:13 -05:00
make.bat Fixed #19516 - Fixed remaining broken links. 2013-01-02 18:32:57 -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/