django/docs
Andrew Godwin 44b00af9bc [1.7.x] Fixed #22874: Document that AUTH_USER_MODEL must be in first migration 2014-06-19 23:48:57 -07: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] Used link label in models FAQ to ease translation 2014-05-22 09:48:04 +02:00
howto [1.7.x] Added link to data migrations in initial data deprecation note 2014-06-11 15:43:53 -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 #22842 2014-06-16 08:45:58 +02:00
man Removed a man page for a command that was removed 2014-01-10 15:23:06 -08:00
misc Fixed #16785 -- Documented some of the design decisions of the cache framework. 2014-01-16 21:13:08 -05:00
ref [1.7.x] Fixed #22874: Document that AUTH_USER_MODEL must be in first migration 2014-06-19 23:48:57 -07:00
releases [1.7.x] Fixed #22660: Doc'd you can't have unmigrated apps depend on migrated 2014-06-15 11:47:57 -07:00
topics [1.7.x] Fixed #22874: Document that AUTH_USER_MODEL must be in first migration 2014-06-19 23:48:57 -07:00
Makefile Fixed #22141 -- Added a spelling checker for documentation. 2014-03-07 09:29:23 -05:00
README Whitespace cleanup. 2013-10-10 16:49:20 -04:00
conf.py [1.7.x] Fixed several typos in Django 2014-05-29 07:53:02 -04:00
contents.txt Removed an obsolete documentation page about admin style customization. 2012-09-10 17:19:35 -07:00
glossary.txt Fixed some typos in the documentation. 2014-03-02 17:05:57 +01:00
index.txt [1.7.x] Link new testing tools document from main index. 2014-05-10 23:29:42 -03:00
make.bat Fixed #19516 - Fixed remaining broken links. 2013-01-02 18:32:57 -05:00
spelling_wordlist [1.7.x] Doc edits for refs #22487. 2014-06-09 12:16:04 -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/