diff options
Diffstat (limited to 'doc/source/ref/horizon.rst')
| -rw-r--r-- | doc/source/ref/horizon.rst | 45 |
1 files changed, 45 insertions, 0 deletions
diff --git a/doc/source/ref/horizon.rst b/doc/source/ref/horizon.rst new file mode 100644 index 00000000..cc4b2d70 --- /dev/null +++ b/doc/source/ref/horizon.rst @@ -0,0 +1,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: |