django

History

Chris Beaven 5bbba4b9ad Fixes #15862 -- Error in post_syncdb documentation example. Thanks for the report and patch andialbrecht. git-svn-id: http://code.djangoproject.com/svn/django/trunk@16091 bcc190cf-cafb-0310-a4f2-bffc1f526a37		2011-04-22 21:23:26 +00:00
..
_ext	…
_theme/djangodocs	…
faq	Fixed #14091 - be more correct about logging queries in connection.queries.	2011-04-22 12:14:54 +00:00
howto	Fixed #15822 -- Removed references to the v1 postgresql backend (which has been removed). Thanks for the patch, aaugustin	2011-04-17 20:45:06 +00:00
internals	Updated the contributing document to accurately reflect our security process.	2011-04-17 14:13:19 +00:00
intro	…
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	…
obsolete	…
ref	Fixes #15862 -- Error in post_syncdb documentation example. Thanks for the report and patch andialbrecht.	2011-04-22 21:23:26 +00:00
releases	Added note about HTML5 to release notes.	2011-04-21 00:00:32 +00:00
topics	Fixed a couple of small documentation typos.	2011-04-22 14:08:31 +00:00
Makefile	…
README	…
conf.py	…
contents.txt	…
glossary.txt	…
index.txt	Changed e-mail to email throughout documentation and codebase. The one exception is translation strings, which I didn't want to disrupt	2011-04-01 16:10:22 +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/