Add config options to the documentation
Add the directive to include the configuration options to the library documentation. Depends-On: I549c8db98bf548dd0a7e8869a57301fa4096f78c (feature change in oslo.config) Depends-On: I89e3e4fd41ed4c989c2dd4c9cd1d7b7e806fa15a (global requirements change to update oslo.config version) Change-Id: Ibec7071027fc33374a73abc30f8f672380bae6ea
This commit is contained in:
parent
03318a936d
commit
0c65ef51c4
@ -12,6 +12,7 @@ extensions = [
|
|||||||
'sphinx.ext.autodoc',
|
'sphinx.ext.autodoc',
|
||||||
'oslosphinx',
|
'oslosphinx',
|
||||||
'stevedore.sphinxext',
|
'stevedore.sphinxext',
|
||||||
|
'oslo_config.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
|
||||||
|
@ -1,6 +1,15 @@
|
|||||||
----------------------
|
=======================
|
||||||
Configuration Options
|
Configuration Options
|
||||||
----------------------
|
=======================
|
||||||
|
|
||||||
|
oslo.messaging uses oslo.config to define and manage configuration
|
||||||
|
options to allow the deployer to control how an application uses the
|
||||||
|
underlying messaging system.
|
||||||
|
|
||||||
|
.. show-options:: oslo.messaging
|
||||||
|
|
||||||
|
API
|
||||||
|
===
|
||||||
|
|
||||||
.. currentmodule:: oslo_messaging.opts
|
.. currentmodule:: oslo_messaging.opts
|
||||||
|
|
||||||
|
@ -5,7 +5,7 @@
|
|||||||
pbr<2.0,>=1.4
|
pbr<2.0,>=1.4
|
||||||
|
|
||||||
futurist>=0.1.2 # Apache-2.0
|
futurist>=0.1.2 # Apache-2.0
|
||||||
oslo.config>=2.1.0 # Apache-2.0
|
oslo.config>=2.3.0 # Apache-2.0
|
||||||
oslo.context>=0.2.0 # Apache-2.0
|
oslo.context>=0.2.0 # Apache-2.0
|
||||||
oslo.log>=1.8.0 # Apache-2.0
|
oslo.log>=1.8.0 # Apache-2.0
|
||||||
oslo.utils>=2.0.0 # Apache-2.0
|
oslo.utils>=2.0.0 # Apache-2.0
|
||||||
|
Loading…
Reference in New Issue
Block a user