django/docs
Loic Bistuer 8222a48253 [1.6.x] Clarfied the ModelForm docs with respect to generated vs. declared fields.
The ModelForm docs suggested that fields defined declaratively override
default fields generated from the form Meta.

This is conceptually wrong, especially with inheritance in mind. Meta is
usually defined on the topmost ModelForm subclass, while fields can come
from anywhere in the MRO, especially base classes; therefore we suggested
that something defined in a base class override something from a subclass.

This patch rephrases the docs around the idea that Meta is used to generate
*missing* fields.

Refs #8620, #19617.

Thanks @mjtamlyn and @timgraham for the review.

Backport of 54cd930baf from master
2013-10-14 10:55:41 -04:00
..
_ext [1.6.x] Added a bugfix in docutils 0.11 -- docs will now build properly. 2013-07-31 09:26:11 -04:00
_theme/djangodocs [1.6.x] Fixed #21702 -- Added different bullet styles for nested lists. 2013-09-23 07:40:01 -04:00
faq [1.6.x] Fixed #19695 -- Retitle "Form Media" to "Form Assets". 2013-07-08 14:09:02 -04:00
howto [1.6.x] Fixed #21218 -- Typo on docs/howto/upgrade-version.txt 2013-10-03 20:14:00 -04:00
internals [1.6.X] Fixed wording in unit tests documentation. 2013-09-25 18:31:03 +02:00
intro [1.6.x] Fixed #21210 -- Documented when runserver doesn't auto-restart. 2013-10-14 10:38:30 -04:00
man Revert "Patch by Claude for #16084." 2013-01-25 13:58:37 -03:00
misc Fixed #19728 - Updated API stability doc to reflect current meaning of "stable". 2013-02-19 18:19:50 -05:00
ref [1.6.x] Fixed #21210 -- Documented when runserver doesn't auto-restart. 2013-10-14 10:38:30 -04:00
releases [1.6.x] Fixed #21164 -- Added documentation for issue with test users. 2013-10-08 10:37:48 +08:00
topics [1.6.x] Clarfied the ModelForm docs with respect to generated vs. declared fields. 2013-10-14 10:55:41 -04:00
conf.py Allow build of translated documentation 2013-06-08 16:13:51 +02:00
contents.txt Removed an obsolete documentation page about admin style customization. 2012-09-10 17:19:35 -07:00
glossary.txt Fixed #18451 -- Vastly improved class based view documentation. 2012-06-11 10:40:23 +02:00
index.txt [1.6.x] Fixed #21121: Added archive of security issues. 2013-09-19 15:02:52 +08:00
make.bat Fixed #19516 - Fixed remaining broken links. 2013-01-02 18:32:57 -05:00
Makefile [1.6.x] Allowed overriding variables in docs/Makefile. 2013-07-29 06:52:42 -04:00
README Fixed #18928. Tightened language in docs/README. 2012-09-08 11:11:37 +05:30

The documentation in this tree is in plain text files and can be viewed using
any text file viewer.

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:

* Install Sphinx (using ``sudo pip install Sphinx`` or some other method)

* In this docs/ directory, type ``make html`` (or ``make.bat html`` on
  Windows) 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/