Add drivers to the documentation
Use stevedore.sphinxext to populate a new page listing all available drivers. Add docstrings to the driver classes, including references to more extensive documentation if it is available. Depends-on: I1a24f9326b4e54174d9dc0ae366315fe29c3ac1b Depends-on: Ie715f98fe0d3cba8b2f4f6235e7c2b6f79be7ea0 Change-Id: Ief0aa05e6deba0126d63faf13497d0fe0539e08d
This commit is contained in:
parent
5b4038ce37
commit
0a8c5145d4
@ -8,7 +8,11 @@ sys.path.insert(0, os.path.abspath('../..'))
|
|||||||
|
|
||||||
# Add any Sphinx extension module names here, as strings. They can be
|
# Add any Sphinx extension module names here, as strings. They can be
|
||||||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
||||||
extensions = ['sphinx.ext.autodoc', 'oslosphinx']
|
extensions = [
|
||||||
|
'sphinx.ext.autodoc',
|
||||||
|
'oslosphinx',
|
||||||
|
'stevedore.sphinxext',
|
||||||
|
]
|
||||||
|
|
||||||
# autodoc generation is a bit aggressive and a nuisance when doing heavy
|
# autodoc generation is a bit aggressive and a nuisance when doing heavy
|
||||||
# text edit cycles.
|
# text edit cycles.
|
||||||
|
6
doc/source/drivers.rst
Normal file
6
doc/source/drivers.rst
Normal file
@ -0,0 +1,6 @@
|
|||||||
|
===================
|
||||||
|
Available Drivers
|
||||||
|
===================
|
||||||
|
|
||||||
|
.. list-plugins:: oslo.messaging.drivers
|
||||||
|
:detailed:
|
@ -21,6 +21,7 @@ Contents
|
|||||||
exceptions
|
exceptions
|
||||||
opts
|
opts
|
||||||
conffixture
|
conffixture
|
||||||
|
drivers
|
||||||
AMQP1.0
|
AMQP1.0
|
||||||
zmq_driver
|
zmq_driver
|
||||||
FAQ
|
FAQ
|
||||||
|
@ -154,6 +154,12 @@ class FakeExchangeManager(object):
|
|||||||
|
|
||||||
|
|
||||||
class FakeDriver(base.BaseDriver):
|
class FakeDriver(base.BaseDriver):
|
||||||
|
"""Fake driver used for testing.
|
||||||
|
|
||||||
|
This driver passes messages in memory, and should only be used for
|
||||||
|
unit tests.
|
||||||
|
|
||||||
|
"""
|
||||||
|
|
||||||
def __init__(self, conf, url, default_exchange=None,
|
def __init__(self, conf, url, default_exchange=None,
|
||||||
allowed_remote_exmods=None):
|
allowed_remote_exmods=None):
|
||||||
|
@ -764,6 +764,9 @@ class Connection(object):
|
|||||||
|
|
||||||
|
|
||||||
class QpidDriver(amqpdriver.AMQPDriverBase):
|
class QpidDriver(amqpdriver.AMQPDriverBase):
|
||||||
|
"""qpidd Driver
|
||||||
|
|
||||||
|
"""
|
||||||
|
|
||||||
def __init__(self, conf, url,
|
def __init__(self, conf, url,
|
||||||
default_exchange=None, allowed_remote_exmods=None):
|
default_exchange=None, allowed_remote_exmods=None):
|
||||||
|
@ -1086,6 +1086,15 @@ class Connection(object):
|
|||||||
|
|
||||||
|
|
||||||
class RabbitDriver(amqpdriver.AMQPDriverBase):
|
class RabbitDriver(amqpdriver.AMQPDriverBase):
|
||||||
|
"""RabbitMQ Driver
|
||||||
|
|
||||||
|
The ``rabbit`` driver is the default driver used in OpenStack's
|
||||||
|
integration tests.
|
||||||
|
|
||||||
|
The driver is aliased as ``kombu`` to support upgrading existing
|
||||||
|
installations with older settings.
|
||||||
|
|
||||||
|
"""
|
||||||
|
|
||||||
def __init__(self, conf, url,
|
def __init__(self, conf, url,
|
||||||
default_exchange=None,
|
default_exchange=None,
|
||||||
|
@ -988,6 +988,11 @@ class ZmqClientPoolManager(object):
|
|||||||
|
|
||||||
|
|
||||||
class ZmqDriver(base.BaseDriver):
|
class ZmqDriver(base.BaseDriver):
|
||||||
|
"""ZeroMQ Driver
|
||||||
|
|
||||||
|
See :doc:`zmq_driver` for details.
|
||||||
|
|
||||||
|
"""
|
||||||
|
|
||||||
# FIXME(markmc): allow this driver to be used without eventlet
|
# FIXME(markmc): allow this driver to be used without eventlet
|
||||||
|
|
||||||
|
@ -121,6 +121,10 @@ class ProtonListener(base.Listener):
|
|||||||
|
|
||||||
|
|
||||||
class ProtonDriver(base.BaseDriver):
|
class ProtonDriver(base.BaseDriver):
|
||||||
|
"""AMQP 1.0 Driver
|
||||||
|
|
||||||
|
See :doc:`AMQP1.0` for details.
|
||||||
|
"""
|
||||||
|
|
||||||
def __init__(self, conf, url,
|
def __init__(self, conf, url,
|
||||||
default_exchange=None, allowed_remote_exmods=[]):
|
default_exchange=None, allowed_remote_exmods=[]):
|
||||||
|
Loading…
x
Reference in New Issue
Block a user