add auto-generated docs for config options
Add automatically generated documentation for the configuration options using oslo_config.sphinxext. Change-Id: I9525a637bc284beaf22e48e80b5c2f8ba7872a8e
This commit is contained in:
parent
8287db165c
commit
cc33b39709
|
@ -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
|
||||||
|
|
|
@ -13,6 +13,7 @@ Contents
|
||||||
installation
|
installation
|
||||||
api
|
api
|
||||||
usage
|
usage
|
||||||
|
opts
|
||||||
contributing
|
contributing
|
||||||
history
|
history
|
||||||
|
|
||||||
|
|
|
@ -0,0 +1,8 @@
|
||||||
|
=======================
|
||||||
|
Configuration Options
|
||||||
|
=======================
|
||||||
|
|
||||||
|
oslo.reports uses oslo.config to define and manage configuration options
|
||||||
|
to allow the deployer to control where the GMR reports should be generated.
|
||||||
|
|
||||||
|
.. show-options:: oslo.reports
|
Loading…
Reference in New Issue