.. _dashboard:

The django-admin-tools dashboard and dashboard modules API
==========================================================

This section describe the API of the django-admin-tools dashboard and
dashboard modules.
Make sure you read this before creating your custom dashboard and
custom modules.

.. module:: admin_tools.dashboard

The ``Dashboard`` class
-----------------------

.. autoclass:: admin_tools.dashboard.Dashboard
    :members:

The ``AppIndexDashboard`` class
-------------------------------

.. autoclass:: admin_tools.dashboard.AppIndexDashboard
    :members:

.. module:: admin_tools.dashboard.modules

The ``DashboardModule`` class
-----------------------------

.. autoclass:: admin_tools.dashboard.modules.DashboardModule
    :members:

The ``Group`` class
------------------------------------

.. autoclass:: admin_tools.dashboard.modules.Group
    :members:

The ``LinkList`` class
-------------------------------------

.. autoclass:: admin_tools.dashboard.modules.LinkList
    :members:

The ``AppList`` class
------------------------------------

.. autoclass:: admin_tools.dashboard.modules.AppList
    :members:

The ``ModelList`` class
--------------------------------------

.. autoclass:: admin_tools.dashboard.modules.ModelList
    :members:

The ``RecentActions`` class
------------------------------------------

.. autoclass:: admin_tools.dashboard.modules.RecentActions
    :members:

The ``Feed`` class
---------------------------------

.. autoclass:: admin_tools.dashboard.modules.Feed
    :members:
