django/docs
Claude Paroz b42930e4b7 [1.7.x] Fixed #23446 -- Officially recommended mysqlclient as MySQL driver
Thanks Corey Farwell for the report and Tim Graham for the review.
Thanks also to Inada Naoki for creating and maintaining mysqlclient.
Backport of 7f089ac2e3 from master.
2014-10-27 09:17:31 +01:00
..
_ext [1.7.x] Added sphinx extension to ease generation of ticket links. 2014-08-19 17:45:59 -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 #23016 -- Updated FAQs per Aymeric's suggestions. 2014-08-12 13:48:21 -04:00
howto [1.7.x] Fixed #23705 -- Removed unnecessary AliasMatch from example Apache config. 2014-10-23 08:51:14 -04:00
internals [1.7.x] Fixed versionchanged indentation in unit-tests.txt. 2014-10-23 08:04:17 -04:00
intro [1.7.x] Replaced dead links to python-distribute.org. 2014-10-24 18:59:17 -04: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 #23446 -- Officially recommended mysqlclient as MySQL driver 2014-10-27 09:17:31 +01:00
releases [1.7.x] Fixed #23621 -- Warn for duplicate models when a module is reloaded. 2014-10-26 00:12:17 +07:00
topics [1.7.x] Fixed versionchanged indentation in topics/testing/advanced.txt. 2014-10-24 15:41:43 -04: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] Removed simplejson inventory file from docs/conf.py. 2014-10-25 08:21:49 -04:00
contents.txt Removed an obsolete documentation page about admin style customization. 2012-09-10 17:19:35 -07:00
glossary.txt [1.7.x] Fixed some intersphinx references. 2014-10-16 20:02:23 -04:00
index.txt [1.7.x] Fixed #22812 -- Refactored lookup API documentation. 2014-07-08 20:13:24 -04:00
make.bat Fixed #19516 - Fixed remaining broken links. 2013-01-02 18:32:57 -05:00
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/