django/docs
Ramiro Morales 2b344d2628 Fixed #14536 -- Corrected DB connection OPTIONS examples in documentation. Thanks denilsonsa for reporting the error.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@14559 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2010-11-14 14:15:58 +00:00
..
_ext Fixed hyperlinking of template tags/filters in offline docs so that non-builtin tags/filters are not hyperlinked to a page where no docs for them exist 2010-11-06 17:42:21 +00:00
_theme/djangodocs
faq Fixed #10904 -- Corrected inappropriate usage of the term "absolute URL" throughout the docs. Replaced with the (RFC 2396-compliant) terms "absolute path reference" or "absolute path" as appropriate for the context. Thanks to sharan666 for the report, and Malcolm, Chris, and dwillis for their work in supplying a solution and patch. 2010-11-07 01:42:55 +00:00
howto Reverted deprecation of media context processor (from r14293) to separate static files and media files a bit more. 2010-11-11 21:44:33 +00:00
internals Fixed a few typos introduced in r14533. 2010-11-13 18:41:24 +00:00
intro Small rewording of tutorial01.txt changes from [14066] 2010-11-08 21:52:32 +00:00
man Refactored runserver command and moved code related to staticfiles to a subclass that is enabled if staticfiles app is installed. 2010-11-13 18:41:55 +00:00
misc
obsolete
ref Fixed #14536 -- Corrected DB connection OPTIONS examples in documentation. Thanks denilsonsa for reporting the error. 2010-11-14 14:15:58 +00:00
releases Added release notes for potential alpha-2. 2010-11-13 18:42:11 +00:00
topics Fixed #14669 -- corrected an ungrammatical sentence in the internationalization docs. Thanks to steveire for the report. 2010-11-12 02:48:26 +00:00
Makefile Fixed #13616 - Updated the documentation to be compatible with Sphinx 1.0. 2010-07-24 10:21:21 +00:00
README Added a README for building offline HTML docs. 2010-11-06 17:44:26 +00:00
conf.py
contents.txt
glossary.txt
index.txt Fixed #14641 - a handful of grammer/typo fixes. 2010-11-08 20:37:52 +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/