From c94fcc4117987c4ebe29ad63da01035230c8afd5 Mon Sep 17 00:00:00 2001
From: Tim Graham <timograham@gmail.com>
Date: Fri, 11 Jan 2013 05:59:17 -0500
Subject: [1.5.x] Fixed #10239 - Added docs for modelform_factory

Thanks ingenieroariel for the suggestion and slurms for the review.

Backport of 71d76ec011 from master
---
 docs/ref/forms/index.txt  |  1 +
 docs/ref/forms/models.txt | 40 ++++++++++++++++++++++++++++++++++++++++
 2 files changed, 41 insertions(+)
 create mode 100644 docs/ref/forms/models.txt

(limited to 'docs/ref/forms')

diff --git a/docs/ref/forms/index.txt b/docs/ref/forms/index.txt
index 866afed6dc..446fdb82de 100644
--- a/docs/ref/forms/index.txt
+++ b/docs/ref/forms/index.txt
@@ -9,5 +9,6 @@ Detailed form API reference. For introductory material, see :doc:`/topics/forms/
 
    api
    fields
+   models
    widgets
    validation
diff --git a/docs/ref/forms/models.txt b/docs/ref/forms/models.txt
new file mode 100644
index 0000000000..1f4a0d0c3d
--- /dev/null
+++ b/docs/ref/forms/models.txt
@@ -0,0 +1,40 @@
+====================
+Model Form Functions
+====================
+
+.. module:: django.forms.models
+   :synopsis: Django's functions for building model forms and formsets.
+
+.. method:: modelform_factory(model, form=ModelForm, fields=None, exclude=None, formfield_callback=None,  widgets=None)
+
+    Returns a :class:`~django.forms.ModelForm` class for the given ``model``.
+    You can optionally pass a ``form`` argument to use as a starting point for
+    constructing the ``ModelForm``.
+
+    ``fields`` is an optional list of field names. If provided, only the named
+    fields will be included in the returned fields.
+
+    ``exclude`` is an optional list of field names. If provided, the named
+    fields will be excluded from the returned fields, even if they are listed
+    in the ``fields`` argument.
+
+    ``widgets`` is a dictionary of model field names mapped to a widget.
+
+    ``formfield_callback`` is a callable that takes a model field and returns
+    a form field.
+
+    See :ref:`modelforms-factory` for example usage.
+
+.. method:: modelformset_factory(model, form=ModelForm, formfield_callback=None, formset=BaseModelFormSet, extra=1, can_delete=False, can_order=False, max_num=None, fields=None, exclude=None)
+
+    Returns a ``FormSet`` class for the given ``model`` class.
+
+    Arguments ``model``, ``form``, ``fields``, ``exclude``, and
+    ``formfield_callback`` are all passed through to
+    :meth:`~django.forms.models.modelform_factory`.
+
+    Arguments ``formset``, ``extra``, ``max_num``, ``can_order``, and
+    ``can_delete`` are passed through to ``formset_factory``. See
+    :ref:`formsets` for details.
+
+    See :ref:`model-formsets` for example usage.
-- 
cgit v1.3