f1a8e0c54f
To better facilitate the building and publishing of sphinx documentation by Jenkins we are moving all openstack projects with sphinx documentation to a common doc tree structure. Documentation goes in project/doc and build results go in project/doc/build. Change-Id: Ic523a716e4113198b777d6dc3db8bb8a729e7696
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:
|