django/docs
Aymeric Augustin 9c41437798 Fixed a typo in the layermapping docs.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@17150 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2011-11-26 08:43:43 +00:00
..
_ext Removed use of non-standard indentation rules in docs, and the custom transform that supported them. 2011-10-10 17:32:33 +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 Fixed #17129 - Model FAQ: Link to south 2011-11-01 22:27:02 +00:00
howto Added support for time zones. Thanks Luke Plant for the review. Fixed #2626. 2011-11-18 13:01:06 +00:00
internals Updated committer bio. 2011-11-18 01:36:57 +00:00
intro Fixed #17028 - Changed diveintopython.org -> diveintopython.net 2011-11-19 22:57:20 +00:00
man Fixed #16099 -- Enabled threading for the runserver management command and added a --nothreading option to disable it if needed. This should help Google Chrome users because it opens more than one connection speculatively. 2011-06-17 13:08:36 +00:00
misc Fixed many more ReST indentation errors, somehow accidentally missed from [16955] 2011-10-14 00:12:01 +00:00
obsolete Fixed #14141: docs now use the :doc: construct for links between documents. 2010-08-19 19:27:44 +00:00
ref Fixed a typo in the layermapping docs. 2011-11-26 08:43:43 +00:00
releases Improved release notes about session cookie httponly flag (#16847) per Luke's comments. 2011-11-22 01:05:14 +00:00
topics Fixed #17220 - Documented git clone command for git < 1.6.6; thanks krzysiumed for the patch. 2011-11-21 23:40:11 +00:00
Makefile Fixed #13616 - Updated the documentation to be compatible with Sphinx 1.0. 2010-07-24 10:21:21 +00:00
README Fixed #16414 -- Added standard Windows make batch file for Sphinx. Thanks, Aymeric Augustin. 2011-07-19 09:00:24 +00:00
conf.py Converted links to external topics so they use intersphinx extension markup. 2011-09-04 21:17:30 +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 Converted links to external topics so they use intersphinx extension markup. 2011-09-04 21:17:30 +00:00
index.txt Fixed #16277 -- Changed the link to the IRC logs. 2011-11-25 19:40:46 +00:00
make.bat Fixed #16414 -- Added standard Windows make batch file for Sphinx. Thanks, Aymeric Augustin. 2011-07-19 09:00:24 +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`` (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/