tuskar-ui/docs/source/ref/horizon.rst
Gabriel Hurley ac71246802 Adds PanelGroup class and site customization hook.
* Adds a PanelGroup class and slightly reworks the way panel
    ordering is handled to fix bug 963550.

  * Adds the option to load a python module containing
    site customizations after the site is fully initialized,
    but before the URLConf is dynamically constructed.
    Fixes bug 965839.

Change-Id: Idc5358f2db6751494bcdfc382ec3bb6af65199b9
2012-03-26 18:22:07 -07:00

46 lines
847 B
ReStructuredText

======================
The ``horizon`` Module
======================
.. module:: horizon
Horizon ships with a single point of contact for hooking into your project if
you aren't developing your own :class:`~horizon.Dashboard` or
:class:`~horizon.Panel`::
import horizon
From there you can access all the key methods you need.
Horizon
=======
.. attribute:: urls
The auto-generated URLconf for Horizon. Usage::
url(r'', include(horizon.urls)),
.. autofunction:: register
.. autofunction:: unregister
.. autofunction:: get_absolute_url
.. autofunction:: get_user_home
.. autofunction:: get_dashboard
.. autofunction:: get_default_dashboard
.. autofunction:: get_dashboards
Dashboard
=========
.. autoclass:: Dashboard
:members:
Panel
=====
.. autoclass:: Panel
:members:
.. autoclass:: PanelGroup
:members: