django/docs
Timo Graham bf5fdf1397 [1.3.X] Fixed #17028 - Changed diveintopython.org -> diveintopython.net
Backport of r17115 from trunk.

git-svn-id: http://code.djangoproject.com/svn/django/branches/releases/1.3.X@17116 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2011-11-19 22:57:47 +00:00
..
_ext Reformated some code for readability. 2010-11-20 21:00:41 +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 [1.3.X] Fixed #15992 -- Added more references to settings. Thanks, aaugustin. 2011-05-29 17:50:52 +00:00
howto [1.3.X] Fixed #17123 -- corrected the path to admin static assets in 1.3 docs. Thanks glarrain for the report. 2011-10-27 16:10:08 +00:00
internals [1.3.X] Altered the behavior of URLField to avoid a potential DOS vector, and to avoid potential leakage of local filesystem data. A security announcement will be made shortly. 2011-09-10 01:08:24 +00:00
intro [1.3.X] Fixed #17028 - Changed diveintopython.org -> diveintopython.net 2011-11-19 22:57:47 +00:00
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 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 [1.3.X] Fixed #17028 - Changed diveintopython.org -> diveintopython.net 2011-11-19 22:57:47 +00:00
releases [1.3.X] Fixed #16839 - Added basic release notes for 1.2.7. Thanks claudep for the report. 2011-09-14 20:33:55 +00:00
topics [1.3.X] Fixed #17028 - Changed diveintopython.org -> diveintopython.net 2011-11-19 22:57:47 +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 [1.3.X] Bump docs version number, too. 2011-09-10 01:34:55 +00:00
contents.txt Fixed #13397 - Include third level headings in the TOC. thanks cyang for the suggestion, rleland for the patch. 2010-12-27 23:58:16 +00:00
glossary.txt Minor markup and organization fixes to docs to correct Sphinx errors. 2011-03-22 14:35:14 +00:00
index.txt Fixed #6181 - Document `django.views.decorators.http` - thanks adamv for the patch. 2010-12-27 13:27:26 +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/