diff options
| author | Doug Hellmann <doug@doughellmann.com> | 2015-08-22 17:01:22 +0000 |
|---|---|---|
| committer | Doug Hellmann <doug@doughellmann.com> | 2015-08-25 17:53:05 +0000 |
| commit | 0c65ef51c4f77658292b15952fd660f7722efbe0 (patch) | |
| tree | ec59aeecf2b28f8675fcdbd15bddb8928d823782 /doc | |
| parent | 03318a936d08cecdfd2842b6f0975f693767f242 (diff) | |
| download | oslo-messaging-0c65ef51c4f77658292b15952fd660f7722efbe0.tar.gz | |
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
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/source/conf.py | 1 | ||||
| -rw-r--r-- | doc/source/opts.rst | 15 |
2 files changed, 13 insertions, 3 deletions
diff --git a/doc/source/conf.py b/doc/source/conf.py index 825fc27..b52d563 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -12,6 +12,7 @@ extensions = [ 'sphinx.ext.autodoc', 'oslosphinx', 'stevedore.sphinxext', + 'oslo_config.sphinxext', ] # autodoc generation is a bit aggressive and a nuisance when doing heavy diff --git a/doc/source/opts.rst b/doc/source/opts.rst index 8fc2bc7..9d94c18 100644 --- a/doc/source/opts.rst +++ b/doc/source/opts.rst @@ -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 |