django

History

Claude Paroz 1dd8848beb [1.3.X] Fixed #17841 -- Clarified caching note about authentication backends. Thanks auzigog for the proposal and lukegb for the patch. Backport of r17752 from trunk. git-svn-id: http://code.djangoproject.com/svn/django/branches/releases/1.3.X@17753 bcc190cf-cafb-0310-a4f2-bffc1f526a37		2012-03-16 19:32:13 +00:00
..
_ext	Reformated some code for readability.	2010-11-20 21:00:41 +00:00
_theme/djangodocs	Fixed #13616 - Updated the documentation to be compatible with Sphinx 1.0.	2010-07-24 10:21:21 +00:00
faq	[1.3.X] Fixed #15992 -- Added more references to settings. Thanks, aaugustin.	2011-05-29 17:50:52 +00:00
howto	[1.3.X] Updated some outdated external URLs in docs.	2012-03-14 07:48:03 +00:00
internals	[1.3.X] Updated some outdated external URLs in docs.	2012-03-14 07:48:03 +00:00
intro	[1.3.X] Fixed #17757 - Typo in docs/intro/overview.txt; thanks kaushik1618.	2012-02-24 22:54:00 +00:00
man	Fixed #7735 -- Added support for IPv6 adresses to runserver and testserver management command. Thanks to Jason Alonso and Łukasz Rekucki for the report and initial patches.	2010-11-26 13:33:53 +00:00
misc	Fixed #14455 -- Documented the backwards compatibility policy for local flavors. Implemented the policy for the changes in the Indonesian local flavor (from r14195) that stimulated the development of this policy. Thanks to Karen, Alex, Ramiro and Chris for their help developing the policy.	2010-11-01 00:52:58 +00:00
obsolete	Fixed #14141 : docs now use the :doc: construct for links between documents.	2010-08-19 19:27:44 +00:00
ref	[1.3.X] Fixed #17837 . Improved markdown safety.	2012-03-14 18:51:20 +00:00
releases	[1.3.X] Fixed #17240 -- Replaced links to the online version of the docs by internal references.	2012-01-26 15:00:57 +00:00
topics	[1.3.X] Fixed #17841 -- Clarified caching note about authentication backends. Thanks auzigog for the proposal and lukegb for the patch.	2012-03-16 19:32:13 +00:00
Makefile	Fixed #13616 - Updated the documentation to be compatible with Sphinx 1.0.	2010-07-24 10:21:21 +00:00
README	Added a README for building offline HTML docs.	2010-11-06 17:44:26 +00:00
conf.py	[1.3.X] Bump docs version number, too.	2011-09-10 01:34:55 +00:00
contents.txt	Fixed #13397 - Include third level headings in the TOC. thanks cyang for the suggestion, rleland for the patch.	2010-12-27 23:58:16 +00:00
glossary.txt	Minor markup and organization fixes to docs to correct Sphinx errors.	2011-03-22 14:35:14 +00:00
index.txt	[1.3.X] Fixed the link to the IRC logs in the README and docs. Refs #17453 , #16277 . Backport of [17149] and [17385].	2012-01-21 15:48:08 +00:00

README

The documentation in this tree is in plain text files and can be viewed using
any text file viewer.

Technically speaking, 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 on a Unix machine (Linux or Mac):

* Install Sphinx (using ``easy_install Sphinx`` or some other method)

* In this docs/ directory, type ``make html`` 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/