django

History

Tim Graham af9949f4ef [1.7.x] Fixed #21942 -- Moved Form.clean() to form API docs. Thanks cjerdonek for the suggestion. Backport of `874053edf9` from master		2014-06-30 16:32:03 -04:00
..
_ext	[1.7.x] Removed duplicate "Deprecated in Django A.B" text in docs.	2014-06-07 07:25:02 -04:00
_theme	[1.7.x] Removed duplicate "Deprecated in Django A.B" text in docs.	2014-06-07 07:25:02 -04:00
faq	[1.7.x] Fixed #22880 -- Added FAQ entry about UnicodeDecodeError	2014-06-24 09:03:06 +02:00
howto	[1.7.x] Fixed typo in parameter name doc for BaseCommand.check().	2014-06-26 07:24:32 -04:00
internals	[1.7.x] Fixed #22818 -- Clarified you need to cd into the Django clone.	2014-06-12 10:53:29 -04:00
intro	[1.7.x] Fixed #22912 -- Warned about a common mistake in tutorial 5.	2014-06-27 09:51:55 -04:00
man	…
misc	…
ref	[1.7.x] Fixed #21942 -- Moved Form.clean() to form API docs.	2014-06-30 16:32:03 -04:00
releases	[1.7.x] Fixed #8033 -- Explained app registry error during translation setup	2014-06-23 09:37:38 +02:00
topics	[1.7.x] Fixed and enhanced new HTML form docs.	2014-06-26 13:59:04 -04:00
Makefile	Fixed #22141 -- Added a spelling checker for documentation.	2014-03-07 09:29:23 -05:00
README	…
conf.py	[1.7.x] Fixed several typos in Django	2014-05-29 07:53:02 -04:00
contents.txt	…
glossary.txt	…
index.txt	[1.7.x] Link new testing tools document from main index.	2014-05-10 23:29:42 -03:00
make.bat	…
spelling_wordlist	[1.7.x] Fixed #22796 -- Added a more basic explanations of forms.	2014-06-24 14:58:53 -04: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-doc.org/