diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/ref/contrib/admin/index.txt | 28 | ||||
| -rw-r--r-- | docs/releases/1.7.txt | 4 |
2 files changed, 32 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 ---------------------- diff --git a/docs/releases/1.7.txt b/docs/releases/1.7.txt index bd22b5513f..d0e4a07374 100644 --- a/docs/releases/1.7.txt +++ b/docs/releases/1.7.txt @@ -135,6 +135,10 @@ Minor features customize the value of :attr:`ModelAdmin.fields <django.contrib.admin.ModelAdmin.fields>`. +* In addition to the existing ``admin.site.register`` syntax, you can use the + new :func:`~django.contrib.admin.register` decorator to register a + :class:`~django.contrib.admin.ModelAdmin`. + :mod:`django.contrib.auth` ^^^^^^^^^^^^^^^^^^^^^^^^^^ |