summaryrefslogtreecommitdiff
path: root/docs/ref/contrib/admin/index.txt
diff options
context:
space:
mode:
Diffstat (limited to 'docs/ref/contrib/admin/index.txt')
-rw-r--r--docs/ref/contrib/admin/index.txt28
1 files changed, 28 insertions, 0 deletions
diff --git a/docs/ref/contrib/admin/index.txt b/docs/ref/contrib/admin/index.txt
index bc26a15b42..dd31d11dee 100644
--- a/docs/ref/contrib/admin/index.txt
+++ b/docs/ref/contrib/admin/index.txt
@@ -101,6 +101,34 @@ Other topics
admin.site.register(Author)
+The register decorator
+----------------------
+
+.. function:: register(*models, [site=django.admin.sites.site])
+
+ .. versionadded:: 1.7
+
+ There is also a decorator for registering your ``ModelAdmin`` classes::
+
+ from django.contrib import admin
+ from .models import Author
+
+ @admin.register(Author)
+ class AuthorAdmin(admin.ModelAdmin):
+ pass
+
+ It is given one or more model classes to register with the ``ModelAdmin``
+ and an optional keyword argument ``site`` if you are not using the default
+ ``AdminSite``::
+
+ from django.contrib import admin
+ from .models import Author, Reader, Editor
+ from myproject.admin_site import custom_admin_site
+
+ @admin.register(Author, Reader, Editor, site=custom_admin_site)
+ class PersonAdmin(admin.ModelAdmin):
+ pass
+
``ModelAdmin`` options
----------------------