django/docs
Gabriel Hurley 1d4640a58f Fixed #15351 -- Corrected a missing word in the template reference docs. Thanks to issackelly for the report and patch.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@15589 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2011-02-19 22:28:39 +00:00
..
_ext
_theme/djangodocs
faq
howto Fixed #15310 -- Corrected a view path in the static files how to docs. Thanks to Bradley Ayers for the report and patch. 2011-02-17 02:11:44 +00:00
internals
intro Fixed #15153 - removed obsolete sentence in tutorial; thanks LeSphinx for the report. 2011-01-26 00:58:41 +00:00
man
misc
obsolete
ref
releases Fixed "the the" typos. 2011-02-14 23:18:30 +00:00
topics
Makefile Fixed #13616 - Updated the documentation to be compatible with Sphinx 1.0. 2010-07-24 10:21:21 +00:00
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/