Commits

Mikhail Korobov committed 0cc912f

More cross-links in docs

Comments (0)

Files changed (4)

admin_tools/dashboard/dashboards.py

     """
     Class that represents an app index dashboard, app index dashboards are
     displayed in the applications index page.
-    ``AppIndexDashboard`` is very similar to the ``Dashboard`` class except
+    :class:`~admin_tools.dashboard.AppIndexDashboard` is very similar to the
+    :class:`~admin_tools.dashboard.Dashboard` class except
     that its constructor receives two extra arguments:
 
     ``app_title``
         Method that returns the list of content types for the current app.
 
     If you want to provide custom app index dashboard, be sure to inherit from
-    this class instead of the ``Dashboard`` class.
+    this class instead of the :class:`~admin_tools.dashboard.Dashboard` class.
 
     Here's an example of a custom app index dashboard::
 

admin_tools/dashboard/modules.py

 
     def init_with_context(self, context):
         """
-        Like for the ``Dashboard`` class, dashboard modules have a
+        Like for the :class:`~admin_tools.dashboard.Dashboard` class, dashboard modules have a
         ``init_with_context`` method that is called with a
         ``django.template.RequestContext`` instance as unique argument.
 
 class LinkList(DashboardModule):
     """
     A module that displays a list of links.
-    As well as the ``DashboardModule`` properties, the
-    ``LinkList`` takes an extra keyword argument:
+    As well as the :class:`~admin_tools.dashboard.modules.DashboardModule`
+    properties, the :class:`~admin_tools.dashboard.modules.LinkList` takes
+    an extra keyword argument:
 
     ``layout``
         The layout of the list, possible values are ``stacked`` and ``inline``.
 class AppList(DashboardModule, AppListElementMixin):
     """
     Module that lists installed apps and their models.
-    As well as the ``DashboardModule`` properties, the
-    ``AppList`` has two extra properties:
+    As well as the :class:`~admin_tools.dashboard.modules.DashboardModule`
+    properties, the :class:`~admin_tools.dashboard.modules.AppList`
+    has two extra properties:
 
     ``exclude_list``
         A list of apps to exclude, if an app name (e.g. "django.contrib.auth"
 class ModelList(DashboardModule, AppListElementMixin):
     """
     Module that lists a set of models.
-    As well as the ``DashboardModule`` properties, the
-    ``ModelList`` takes two extra keyword arguments:
+    As well as the :class:`~admin_tools.dashboard.modules.DashboardModule`
+    properties, the :class:`~admin_tools.dashboard.modules.ModelList` takes
+    two extra keyword arguments:
 
     ``include_list``
         A list of models to include, only models whose name (e.g.
 class RecentActions(DashboardModule):
     """
     Module that lists the recent actions for the current user.
-    As well as the ``DashboardModule`` properties, the
-    ``RecentActions`` takes three extra keyword arguments:
+    As well as the :class:`~admin_tools.dashboard.modules.DashboardModule`
+    properties, the :class:`~admin_tools.dashboard.modules.RecentActions`
+    takes three extra keyword arguments:
 
     ``include_list``
         A list of contenttypes (e.g. "auth.group" or "sites.site") to include,
         the feeds, so you'll need to install it, all feeds supported by
         FeedParser are thus supported by the Feed
 
-    As well as the ``DashboardModule`` properties, the ``Feed``
-    takes two extra keyword arguments:
+    As well as the :class:`~admin_tools.dashboard.modules.DashboardModule`
+    properties, the :class:`~admin_tools.dashboard.modules.Feed` takes two
+    extra keyword arguments:
 
     ``feed_url``
         The URL of the feed.

admin_tools/menu/items.py

 class AppList(MenuItem, AppListElementMixin):
     """
     A menu item that lists installed apps an their models.
-    In addition to the parent ``MenuItem`` properties, the ``AppList``
-    has two extra properties:
+    In addition to the parent :class:`~admin_tools.menu.items.MenuItem`
+    properties, the ``AppList`` has two extra properties:
 
     ``exclude_list``
         A list of apps to exclude, if an app name (e.g. "django.contrib.auth"
 
     def init_with_context(self, context):
         """
-        Please refer to the ``MenuItem::init_with_context()`` documentation.
+        Please refer to the :meth:`~admin_tools.menu.items.MenuItem.init_with_context`
+        documentation from :class:`~admin_tools.menu.items.MenuItem` class.
         """
         request = context['request']
         apps = {}
 
     def init_with_context(self, context):
         """
-        Please refer to the ``MenuItem::init_with_context()`` documentation.
+        Please refer to the :meth:`~admin_tools.menu.items.MenuItem.init_with_context`
+        documentation from :class:`~admin_tools.menu.items.MenuItem` class.
         """
         from admin_tools.menu.models import Bookmark
         for b in Bookmark.objects.filter(user=context['request'].user):

admin_tools/menu/menus.py

 
     ``children``
         A list of children menu items. All children items mus be instances of
-        the ``MenuItem`` class.
+        the :class:`~admin_tools.menu.items.MenuItem` class.
 
     If you want to customize the look of your menu and it's menu items, you
     can declare css stylesheets and/or javascript files to include when