openstack/deb-aodh
Code Issues Proposed changes

Use stevedore directive to document plugins

Browse Source 
Add directives to the documentation to bring in the docstrings from the
plugins.

Change-Id: I579a09a80a1e41ac7f3daa98204d9a3c7414ae4e
This commit is contained in:
Doug Hellmann 2015-07-24 20:10:50 +00:00
parent 61717e7a8d
commit 5587b17c65
4 changed files with 27 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
doc/source/architecture.rst
View File

@ -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. will be critical in all cases of production deployment.
.. _Autoscaling with Heat and Ceilometer: http://techs.enovance.com/5991/autoscaling-with-heat-and-ceilometer .. _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:

3
doc/source/conf.py
View File

@ -46,7 +46,8 @@ extensions = [
'sphinx.ext.viewcode', 'sphinx.ext.viewcode',
'sphinxcontrib.pecanwsme.rest', 'sphinxcontrib.pecanwsme.rest',
'oslosphinx', 'oslosphinx',
'sphinxcontrib.docbookrestapi.setup' 'sphinxcontrib.docbookrestapi.setup',
'stevedore.sphinxext',
] ]
wsme_protocols = ['restjson', 'restxml'] wsme_protocols = ['restjson', 'restxml']

1
doc/source/install/index.rst
View File

@ -24,4 +24,5 @@
development development
manual manual
storage
mod_wsgi mod_wsgi

6
doc/source/install/storage.rst Normal file
View File

@ -0,0 +1,6 @@
=================
Storage Drivers
=================
.. list-plugins:: aodh.storage
:detailed: