django

mirror of https://github.com/django/django.git synced 2024-12-01 15:42:04 +01:00

History

Gabriel Hurley 66594beae7 Fixed #15657 -- added the required `form` parameter to the method signatures of `form_valid` and `form_invalid` in the `FormMixin` docs. Thanks to jnns for the report. git-svn-id: http://code.djangoproject.com/svn/django/trunk@15895 bcc190cf-cafb-0310-a4f2-bffc1f526a37		2011-03-22 22:01:27 +00:00
..
_ext	Reformated some code for readability.	2010-11-20 21:00:41 +00:00
_theme/djangodocs
faq	Minor markup and organization fixes to docs to correct Sphinx errors.	2011-03-22 14:35:14 +00:00
howto	Tweaked title level in custom file storage systems documentation.	2011-03-21 15:39:26 +00:00
internals	Update release notes and other docs for impending 1.3.	2011-03-22 06:57:12 +00:00
intro	Fixed #15257 - Add a link about field lookups to the tutorial; thanks dwillis.	2011-02-22 00:57:28 +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 #15657 -- added the required `form` parameter to the method signatures of `form_valid` and `form_invalid` in the `FormMixin` docs. Thanks to jnns for the report.	2011-03-22 22:01:27 +00:00
releases	Corrected a number of mislinked crossrefs and added a few new crossref targets found in/via the 1.3 release.	2011-03-22 20:12:17 +00:00
topics	Corrected a number of mislinked crossrefs and added a few new crossref targets found in/via the 1.3 release.	2011-03-22 20:12:17 +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	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
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/