summaryrefslogtreecommitdiff
path: root/docs/source/ref/horizon.rst
blob: cc4b2d7099d9e84422d8672cea6f9c47b2fd40a2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
======================
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: