django

mirror of https://github.com/django/django.git synced 2024-12-24 10:05:46 +00:00

History

Timo Graham 3cdd6d898e Fixed #15204 - Update form examples for rendering of the help_text; thanks prestontimmons. git-svn-id: http://code.djangoproject.com/svn/django/trunk@15396 bcc190cf-cafb-0310-a4f2-bffc1f526a37		2011-02-02 20:23:13 +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	Some tweaks to the staticfiles docs to clarify things for new users. Thanks Jannis and brutasse for review and discussion.	2011-01-31 22:06:53 +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	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	Fixed #15204 - Update form examples for rendering of the help_text; thanks prestontimmons.	2011-02-02 20:23:13 +00:00
releases	Added note to 1.2.5 release notes about ModelAdmin.lookup_allowed change	2011-01-28 15:47:40 +00:00
topics	Reworded parts of the staticfiles documentation after receiving various user feedback. Thanks, all!	2011-01-30 17:23:25 +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	Fixed #14141 : docs now use the :doc: construct for links between documents.	2010-08-19 19:27:44 +00:00
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/