Documentation of dashboard module groups.

This commit is contained in:
David Jean Louis 2010-07-10 12:37:11 +02:00
parent 2246b240ea
commit 38dca63ba9
4 changed files with 16 additions and 2 deletions

View File

@ -170,7 +170,7 @@ class Group(DashboardModule):
``display``
A string determining how the group should be rendered, this can be one
of the following values: 'stacked' (default), 'tabs' or 'accordion'.
of the following values: 'tabs' (default), 'accordion' or 'stacked'.
Here's an example of modules group::
@ -193,6 +193,10 @@ class Group(DashboardModule):
)
]
))
The screenshot of what this code produces:
.. image:: images/dashboard_module_group.png
"""
def __init__(self, **kwargs):

View File

@ -18,7 +18,7 @@ import sys, os
# documentation root, use os.path.abspath to make it absolute, like shown here.
sys.path.append(os.path.abspath('..'))
# required for autodoc
os.environ['DJANGO_SETTINGS_MODULE'] = 'django.conf.global_settings'
os.environ['DJANGO_SETTINGS_MODULE'] = 'test_proj.settings'
# -- General configuration -----------------------------------------------------

View File

@ -8,6 +8,8 @@ dashboard modules.
Make sure you read this before creating your custom dashboard and
custom modules.
.. module:: admin_tools.dashboard
The ``Dashboard`` class
-----------------------
@ -20,12 +22,20 @@ 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
-------------------------------------

Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB