diff options
| author | Craige McWhirter <craige@mcwhirter.com.au> | 2015-08-28 14:04:18 +1000 |
|---|---|---|
| committer | Craige McWhirter <craige@mcwhirter.com.au> | 2015-09-18 15:35:45 +1000 |
| commit | 907105d33194809b8af915dc6219a3d67f01e24c (patch) | |
| tree | 689e1b57c953e64b263be56b0a7cc91166bb8342 | |
| parent | b73aa5c3abcea74716e236e8fd41475a5dc8dbdd (diff) | |
| download | oslo-middleware-907105d33194809b8af915dc6219a3d67f01e24c.tar.gz | |
Add plugin doco generated with stevedore.sphinxext
As per:
http://lists.openstack.org/pipermail/openstack-dev/2015-August/073338.html
The point behind the addition of the stevedore.sphinxext extension is
"to document drivers and other types of plugins to make the available
sets built into projects easier to discover" (dhellman).
Change-Id: If24f70704dd4840c44e6e72928157078fea80b51
| -rwxr-xr-x | doc/source/conf.py | 1 | ||||
| -rw-r--r-- | doc/source/healthcheck_plugins.rst | 7 |
2 files changed, 8 insertions, 0 deletions
diff --git a/doc/source/conf.py b/doc/source/conf.py index 6265ab6..a5301af 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -25,6 +25,7 @@ extensions = [ #'sphinx.ext.intersphinx', 'oslosphinx', 'oslo_config.sphinxext', + 'stevedore.sphinxext', ] # autodoc generation is a bit aggressive and a nuisance when doing heavy diff --git a/doc/source/healthcheck_plugins.rst b/doc/source/healthcheck_plugins.rst index 04683cc..3ea93c5 100644 --- a/doc/source/healthcheck_plugins.rst +++ b/doc/source/healthcheck_plugins.rst @@ -7,3 +7,10 @@ .. automodule:: oslo_middleware.healthcheck.disable_by_file :members: + + +Available Plugins +------------------ + +.. list-plugins:: oslo.middleware.healthcheck + :detailed: |