django

mirror of https://github.com/django/django.git synced 2024-12-25 02:26:12 +00:00

History

Gabriel Hurley 8ee9a4627e Fixed #15341 -- Clarified where translation problems should be reported in the contributing docs. Thanks to bpeschier for the report and patch. git-svn-id: http://code.djangoproject.com/svn/django/trunk@15590 bcc190cf-cafb-0310-a4f2-bffc1f526a37		2011-02-19 23:59:59 +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 #15310 -- Corrected a view path in the static files how to docs. Thanks to Bradley Ayers for the report and patch.	2011-02-17 02:11:44 +00:00
internals	Fixed #15341 -- Clarified where translation problems should be reported in the contributing docs. Thanks to bpeschier for the report and patch.	2011-02-19 23:59:59 +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 #15351 -- Corrected a missing word in the template reference docs. Thanks to issackelly for the report and patch.	2011-02-19 22:28:39 +00:00
releases	Fixed "the the" typos.	2011-02-14 23:18:30 +00:00
topics	Fixed #15347 -- Corrected a typo in the l10n docs. Thanks to RaceCondition for the report.	2011-02-18 22:42:37 +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/