Use stevedore directive to document plugins
Add directives to the documentation to bring in the docstrings from the plugins. Change-Id: I579a09a80a1e41ac7f3daa98204d9a3c7414ae4e
This commit is contained in:
parent
61717e7a8d
commit
5587b17c65
@ -51,3 +51,21 @@ database setup (using a separate database from the one used for metering)
|
||||
will be critical in all cases of production deployment.
|
||||
|
||||
.. _Autoscaling with Heat and Ceilometer: http://techs.enovance.com/5991/autoscaling-with-heat-and-ceilometer
|
||||
|
||||
Alarm Rules
|
||||
===========
|
||||
|
||||
.. list-plugins:: aodh.alarm.rule
|
||||
:detailed:
|
||||
|
||||
Alarm Evaluators
|
||||
================
|
||||
|
||||
.. list-plugins:: aodh.evaluator
|
||||
:detailed:
|
||||
|
||||
Alarm Notifiers
|
||||
===============
|
||||
|
||||
.. list-plugins:: aodh.notifier
|
||||
:detailed:
|
||||
|
@ -46,7 +46,8 @@ extensions = [
|
||||
'sphinx.ext.viewcode',
|
||||
'sphinxcontrib.pecanwsme.rest',
|
||||
'oslosphinx',
|
||||
'sphinxcontrib.docbookrestapi.setup'
|
||||
'sphinxcontrib.docbookrestapi.setup',
|
||||
'stevedore.sphinxext',
|
||||
]
|
||||
|
||||
wsme_protocols = ['restjson', 'restxml']
|
||||
|
@ -24,4 +24,5 @@
|
||||
|
||||
development
|
||||
manual
|
||||
storage
|
||||
mod_wsgi
|
||||
|
6
doc/source/install/storage.rst
Normal file
6
doc/source/install/storage.rst
Normal file
@ -0,0 +1,6 @@
|
||||
=================
|
||||
Storage Drivers
|
||||
=================
|
||||
|
||||
.. list-plugins:: aodh.storage
|
||||
:detailed:
|
Loading…
Reference in New Issue
Block a user