django

History

Chris Beaven ea145923fc Better cross-referencing of the USE_THOUSAND_SEPARATOR setting in documentation. Thanks to Klaas van Schelven for the patch. git-svn-id: http://code.djangoproject.com/svn/django/trunk@14578 bcc190cf-cafb-0310-a4f2-bffc1f526a37		2010-11-16 21:33:48 +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	Fixed #13616 - Updated the documentation to be compatible with Sphinx 1.0.	2010-07-24 10:21:21 +00:00
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	Added info about using logging to the 'Error reporting' howto.	2010-11-16 14:00:38 +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	Fixed #14455 -- Documented the backwards compatibility policy for local flavors. Implemented the policy for the changes in the Indonesian local flavor (from r14195) that stimulated the development of this policy. Thanks to Karen, Alex, Ramiro and Chris for their help developing the policy.	2010-11-01 00:52:58 +00:00
obsolete	Fixed #14141 : docs now use the :doc: construct for links between documents.	2010-08-19 19:27:44 +00:00
ref	Better cross-referencing of the USE_THOUSAND_SEPARATOR setting in documentation. Thanks to Klaas van Schelven for the patch.	2010-11-16 21:33:48 +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	Disabled unused Sphinx configuration option that triggered a warning.	2010-10-08 15:33:27 +00:00
contents.txt	Massive reorganization of the docs. See the new docs online at http://docs.djangoproject.com/.	2008-08-23 22:25:40 +00:00
glossary.txt	Fixed #14141 : docs now use the :doc: construct for links between documents.	2010-08-19 19:27:44 +00:00
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/