summaryrefslogtreecommitdiff
path: root/docs/ref
diff options
context:
space:
mode:
authorAustin Simmons <autto91@gmail.com>2016-09-19 20:29:57 -0700
committerTim Graham <timograham@gmail.com>2016-09-27 12:16:44 -0400
commit0f6829a68afb91abfdea8489008ebffac3d5220c (patch)
treec2efdaa7ceaf085ca9b340b84f7639cf201dc2b9 /docs/ref
parent617e36dc1ede2a311dfd03f18432b31cbfe4c0f7 (diff)
Fixed #27076 -- Documented contrib.admin.sites.AdminSite.register().
Diffstat (limited to 'docs/ref')
-rw-r--r--docs/ref/contrib/admin/index.txt12
1 files changed, 12 insertions, 0 deletions
diff --git a/docs/ref/contrib/admin/index.txt b/docs/ref/contrib/admin/index.txt
index 74395def6a..845f467b77 100644
--- a/docs/ref/contrib/admin/index.txt
+++ b/docs/ref/contrib/admin/index.txt
@@ -2658,6 +2658,18 @@ Templates can override or extend base admin templates as described in
:attr:`User.is_staff <django.contrib.auth.models.User.is_staff>` to be
``True``.
+.. method:: AdminSite.register(model_or_iterable, admin_class=None, **options)
+
+ Registers the given model class (or iterable of classes) with the given
+ ``admin_class``. ``admin_class`` defaults to
+ :class:`~django.contrib.admin.ModelAdmin` (the default admin options). If
+ keyword arguments are given -- e.g. ``list_display`` -- they'll be applied
+ as options to the admin class.
+
+ Raises :class:`~django.core.exceptions.ImproperlyConfigured` if a model is
+ abstract. and ``django.contrib.admin.sites.AlreadyRegistered`` if a model
+ is already registered.
+
Hooking ``AdminSite`` instances into your URLconf
-------------------------------------------------