django

mirror of https://github.com/django/django.git synced 2024-11-18 15:34:16 +00:00

History

Russell Keith-Magee 41dc3fc2e8 Fixed #15253 -- Added 1.1.3 release notes, and added sections to the 1.2.4 and 1.3 release notes about the December security announcement. git-svn-id: http://code.djangoproject.com/svn/django/trunk@15485 bcc190cf-cafb-0310-a4f2-bffc1f526a37		2011-02-10 11:55:24 +00:00
..
_ext	Reformated some code for readability.	2010-11-20 21:00:41 +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	Fixed #15138 -- Clarified a slightly ambiguous example in the custom template tag docs. Thanks to elbarto for the report and patch.	2011-02-07 23:44:43 +00:00
internals	Fixed #13662 -- Added an entry in the README to direct people to the instructions for running the test suite, and cleaned up that section of the docs. Thanks to mir for the report, and to cogat and gg for the draft text.	2011-01-27 03:14:49 +00:00
intro	Fixed #15153 - removed obsolete sentence in tutorial; thanks LeSphinx for the report.	2011-01-26 00:58:41 +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
obsolete
ref	Fixed a security issue in the CSRF component. Disclosure and new release forthcoming.	2011-02-09 02:06:27 +00:00
releases	Fixed #15253 -- Added 1.1.3 release notes, and added sections to the 1.2.4 and 1.3 release notes about the December security announcement.	2011-02-10 11:55:24 +00:00
topics	Refs #15241 -- Further clarifications to the generic view migration docs.	2011-02-09 13:04:05 +00:00
conf.py	Fixed #15196 -- Bumped version up a bit in Sphinx configuration. Thanks, Eric Holscher.	2011-01-30 20:31:39 +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
index.txt	Fixed #6181 - Document `django.views.decorators.http` - thanks adamv for the patch.	2010-12-27 13:27:26 +00:00
Makefile
README	Added a README for building offline HTML docs.	2010-11-06 17:44: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/