package documentation

Undocumented

Module apps No module docstring; 2/2 classes documented
Module models Undocumented
Module actions Built-in, globally-available admin actions.
Module checks No module docstring; 3/7 functions, 0/3 class documented
Module decorators Undocumented
Module exceptions No module docstring; 2/2 classes documented
Module filters This encapsulates the logic for displaying filters in the Django admin. Filters are specified in models with the "list_filter" option.
Module forms No module docstring; 1/2 class documented
Module helpers No module docstring; 0/1 variable, 0/1 constant, 3/10 classes documented
Package migrations Undocumented
Module options No module docstring; 0/1 variable, 0/3 constant, 0/2 function, 2/3 classes documented
Module sites Undocumented
Package templatetags Undocumented
Module tests No module docstring; 1/2 class documented
Module utils No module docstring; 0/3 constant, 14/20 functions, 1/3 class documented
Package views Undocumented
Module widgets Form Widget classes specific to the Django admin site.

From __init__.py:

Class ​Admin​Site No summary
Class ​Model​Admin Encapsulate all admin options and functionality for a given model.
Class ​Stacked​Inline Undocumented
Class ​Tabular​Inline Undocumented
Function action Conveniently add attributes to an action function:
Function autodiscover Undocumented
Function display Conveniently add attributes to a display function:
Function register Register the given model(s) classes and wrapped ModelAdmin class with admin site:
Constant HORIZONTAL Undocumented
Constant VERTICAL Undocumented
Variable site Undocumented
Class ​All​Values​Field​List​Filter Undocumented
Class ​Boolean​Field​List​Filter Undocumented
Class ​Choices​Field​List​Filter Undocumented
Class ​Date​Field​List​Filter Undocumented
Class ​Empty​Field​List​Filter Undocumented
Class ​Field​List​Filter Undocumented
Class ​List​Filter No class docstring; 0/1 instance variable, 0/2 class variable, 4/5 methods documented
Class ​Related​Field​List​Filter No class docstring; 1/1 property, 0/8 instance variable, 1/6 method documented
Class ​Related​Only​Field​List​Filter Undocumented
Class ​Simple​List​Filter No class docstring; 0/1 instance variable, 0/1 class variable, 2/6 methods documented
def action(function=None, *, permissions=None, description=None):

Conveniently add attributes to an action function:

@admin.action(
    permissions=['publish'],
    description='Mark selected stories as published',
)
def make_published(self, request, queryset):
    queryset.update(status='p')

This is equivalent to setting some attributes (with the original, longer names) on the function directly:

def make_published(self, request, queryset):
    queryset.update(status='p')
make_published.allowed_permissions = ['publish']
make_published.short_description = 'Mark selected stories as published'
def display(function=None, *, boolean=None, ordering=None, description=None, empty_value=None):

Conveniently add attributes to a display function:

@admin.display(
    boolean=True,
    ordering='-publish_date',
    description='Is Published?',
)
def is_published(self, obj):
    return obj.publish_date is not None

This is equivalent to setting some attributes (with the original, longer names) on the function directly:

def is_published(self, obj):
    return obj.publish_date is not None
is_published.boolean = True
is_published.admin_order_field = '-publish_date'
is_published.short_description = 'Is Published?'
def register(*models, site=None):

Register the given model(s) classes and wrapped ModelAdmin class with admin site:

@register(Author) class AuthorAdmin(admin.ModelAdmin):

pass

The site kwarg is an admin site to use instead of the default admin site.

HORIZONTAL =

Undocumented

VERTICAL =

Undocumented

site =

Undocumented

def autodiscover():

Undocumented