django/docs
Malcolm Tredinnick e3cd0e6710 Typo fix in class-based view documentation.
Fixed #16666. Thanks saebyn.

git-svn-id: http://code.djangoproject.com/svn/django/trunk@16640 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2011-08-22 02:03:50 +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 Update my committer bio since I work somewhere else now. 2011-08-21 15:45:09 +00:00
intro Fixed #16414 -- Added standard Windows make batch file for Sphinx. Thanks, Aymeric Augustin. 2011-07-19 09:00:24 +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
obsolete
ref Typo fix in class-based view documentation. 2011-08-22 02:03:50 +00:00
releases Fixed #16621 -- Fixed lots of typos in the docs. Thanks, Bernhard Essl. 2011-08-13 11:58:19 +00:00
topics Made documentation of ManyToManyField placement clearer (kind of). 2011-08-22 01:07:19 +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
contents.txt
glossary.txt Minor markup and organization fixes to docs to correct Sphinx errors. 2011-03-22 14:35:14 +00:00
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/