add auto-generated docs for config options
Add automatically generated documentation for the configuration options using oslo_config.sphinxext. Change-Id: I8a58303b09aa5b0c04c083c85d50b87e3efe28e0
This commit is contained in:
@@ -23,7 +23,8 @@ sys.path.insert(0, os.path.abspath('../..'))
|
|||||||
extensions = [
|
extensions = [
|
||||||
'sphinx.ext.autodoc',
|
'sphinx.ext.autodoc',
|
||||||
#'sphinx.ext.intersphinx',
|
#'sphinx.ext.intersphinx',
|
||||||
'oslosphinx'
|
'oslosphinx',
|
||||||
|
'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
|
||||||
@@ -72,4 +73,4 @@ latex_documents = [
|
|||||||
]
|
]
|
||||||
|
|
||||||
# Example configuration for intersphinx: refer to the Python standard library.
|
# Example configuration for intersphinx: refer to the Python standard library.
|
||||||
#intersphinx_mapping = {'http://docs.python.org/': None}
|
#intersphinx_mapping = {'http://docs.python.org/': None}
|
||||||
|
|||||||
@@ -12,6 +12,7 @@ logging (like resource id's etc).
|
|||||||
|
|
||||||
installation
|
installation
|
||||||
usage
|
usage
|
||||||
|
opts
|
||||||
contributing
|
contributing
|
||||||
history
|
history
|
||||||
|
|
||||||
|
|||||||
9
doc/source/opts.rst
Normal file
9
doc/source/opts.rst
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
=======================
|
||||||
|
Configuration Options
|
||||||
|
=======================
|
||||||
|
|
||||||
|
oslo.log uses oslo.config to define and manage configuration options
|
||||||
|
to allow the deployer to control how an application's logs are
|
||||||
|
handled.
|
||||||
|
|
||||||
|
.. show-options:: oslo.log
|
||||||
Reference in New Issue
Block a user