django/docs
Russell Keith-Magee be4acff319 Reverted r16662 -- There are bunch of problems with this patch, including failing tests, that I didn't pick up before committing.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@16669 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2011-08-23 06:31:03 +00:00
..
_ext
_theme/djangodocs
faq
howto Fixed #15252 -- Added static template tag and CachedStaticFilesStorage to staticfiles contrib app. 2011-08-11 14:07:39 +00:00
internals Added myself to the list of committers. 2011-08-23 01:41:47 +00:00
intro Fixed #16669 -- Made the startproject instruction formatting easier to read and more consistent with other formatting in the tutorial part 1. Thanks to Daniel Lawrence and Aymeric Augustin. 2011-08-23 05:24:31 +00:00
man
misc
obsolete
ref Reverted r16662 -- There are bunch of problems with this patch, including failing tests, that I didn't pick up before committing. 2011-08-23 06:31:03 +00:00
releases Reverted r16662 -- There are bunch of problems with this patch, including failing tests, that I didn't pick up before committing. 2011-08-23 06:31:03 +00:00
topics Fixed #15499 -- Ensure that cache control headers don't try to set public and private as a result of multiple calls to patch_cache_control with different arguments. Thanks to AndiDog for the report and patch. 2011-08-23 03:51:10 +00:00
Makefile
README Fixed #16414 -- Added standard Windows make batch file for Sphinx. Thanks, Aymeric Augustin. 2011-07-19 09:00:24 +00:00
conf.py
contents.txt
glossary.txt
index.txt
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/