03bf2b7f5d
changed file to comply with official doc conventions horizon should be lowercase per the official name and capitalization section in the wiki documentation conventions for OpenStack https://wiki.openstack.org/wiki/Documentation/Conventions Partial-bug: 1446253 Change-Id: Icdec9764535c509432b60ac2b3aee54da40d2085
46 lines
847 B
ReStructuredText
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:
|