django

History

Simon Meers 5ecb88c146 Fixed #16014 -- numerous documentation typos -- thanks psmith. git-svn-id: http://code.djangoproject.com/svn/django/trunk@16220 bcc190cf-cafb-0310-a4f2-bffc1f526a37		2011-05-13 04:33:42 +00:00
..
_ext	Reformated some code for readability.	2010-11-20 21:00:41 +00:00
_theme/djangodocs	…
faq	Fixed #14091 - be more correct about logging queries in connection.queries.	2011-04-22 12:14:54 +00:00
howto	Fixed #16014 -- numerous documentation typos -- thanks psmith.	2011-05-13 04:33:42 +00:00
internals	Fixed #16014 -- numerous documentation typos -- thanks psmith.	2011-05-13 04:33:42 +00:00
intro	Fixed #16014 -- numerous documentation typos -- thanks psmith.	2011-05-13 04:33:42 +00:00
man	…
misc	…
obsolete	…
ref	Fixed #16014 -- numerous documentation typos -- thanks psmith.	2011-05-13 04:33:42 +00:00
releases	Fixed #16014 -- numerous documentation typos -- thanks psmith.	2011-05-13 04:33:42 +00:00
topics	Fixed #16014 -- numerous documentation typos -- thanks psmith.	2011-05-13 04:33:42 +00:00
Makefile	…
README	…
conf.py	…
contents.txt	…
glossary.txt	…
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/