add plugin documentation for executors and notifiers
Document the plugins available for executors and notifiers. Fix the formatting in the aioeventlet executor so the docstring renders properly. Change-Id: I7709b65f5aa68fab3822b4de11640309aa07b1d7
This commit is contained in:
parent
d94d6d6892
commit
1b390c34b0
@ -1,15 +1,13 @@
|
||||
---------
|
||||
=========
|
||||
Executors
|
||||
---------
|
||||
|
||||
.. automodule:: oslo_messaging._executors
|
||||
|
||||
.. currentmodule:: oslo_messaging
|
||||
|
||||
==============
|
||||
Executor types
|
||||
==============
|
||||
=========
|
||||
|
||||
Executors are providing the way an incoming message will be dispatched so that
|
||||
the message can be used for meaningful work. Different types of executors are
|
||||
supported, each with its own set of restrictions and capabilities.
|
||||
|
||||
Available Executors
|
||||
===================
|
||||
|
||||
.. list-plugins:: oslo.messaging.executors
|
||||
:detailed:
|
||||
|
@ -1,6 +1,6 @@
|
||||
--------
|
||||
Notifier
|
||||
--------
|
||||
==========
|
||||
Notifier
|
||||
==========
|
||||
|
||||
.. currentmodule:: oslo_messaging
|
||||
|
||||
@ -12,3 +12,9 @@ Notifier
|
||||
|
||||
.. autoclass:: LoggingErrorNotificationHandler
|
||||
:members:
|
||||
|
||||
Available Notifier Drivers
|
||||
==========================
|
||||
|
||||
.. list-plugins:: oslo.messaging.notify.drivers
|
||||
:detailed:
|
||||
|
@ -30,7 +30,7 @@ class AsyncioEventletExecutor(impl_eventlet.EventletExecutor):
|
||||
To use the executor, an aioeventlet event loop must the running in the
|
||||
thread executing the executor (usually the main thread). Example of code to
|
||||
setup and run an aioeventlet event loop for the executor (in the main
|
||||
thread):
|
||||
thread)::
|
||||
|
||||
import aioeventlet
|
||||
import trollius
|
||||
@ -48,6 +48,7 @@ class AsyncioEventletExecutor(impl_eventlet.EventletExecutor):
|
||||
# run the event loop in a new greenthread,
|
||||
# close it when it is done
|
||||
eventlet.spawn(run_loop, loop)
|
||||
|
||||
"""
|
||||
|
||||
def __init__(self, conf, listener, dispatcher):
|
||||
|
Loading…
Reference in New Issue
Block a user