David Jean Louis avatar David Jean Louis committed f7d6813

Documentation of dashboard module groups.

Comments (0)

Files changed (4)

admin_tools/dashboard/modules.py

 
     ``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::
         
                         )
                     ]
                 ))
+
+    The screenshot of what this code produces:
+
+    .. image:: images/dashboard_module_group.png
     """
 
     def __init__(self, **kwargs):
 # 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 -----------------------------------------------------
 

docs/dashboard.rst

 Make sure you read this before creating your custom dashboard and
 custom modules.
 
+.. module:: admin_tools.dashboard
+
 The ``Dashboard`` 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
 -------------------------------------
 
Add a comment to this file

docs/images/dashboard_module_group.png

Added
New image
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.