django/docs
Timo Graham d665c0b3b9 Fixed #15664 - Removed extra parens in commit_on_success example.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@15923 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2011-03-27 23:00:36 +00:00
..
_ext
_theme/djangodocs
faq Minor markup and organization fixes to docs to correct Sphinx errors. 2011-03-22 14:35:14 +00:00
howto Corrected another part of the staticfiles docs which was missed in r15913. Refs #15681. 2011-03-24 17:58:13 +00:00
internals Update release notes and other docs for impending 1.3. 2011-03-22 06:57:12 +00:00
intro
man
misc
obsolete Fixed #14141: docs now use the :doc: construct for links between documents. 2010-08-19 19:27:44 +00:00
ref Fixed typo in forms API documentation. 2011-03-22 23:16:22 +00:00
releases Fixed a few typos in the 1.3 release notes. 2011-03-23 08:48:18 +00:00
topics Fixed #15664 - Removed extra parens in commit_on_success example. 2011-03-27 23:00:36 +00:00
Makefile
README
conf.py Bumped django_next_version so that "New in Django 1.3" links appear correctly. 2011-03-24 09:40:50 +00:00
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

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/