openstack
/
oslo.reports
Code Issues Proposed changes

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:
Davanum Srinivas 2015-09-25 06:53:01 -04:00
parent 8287db165c
commit cc33b39709
3 changed files with 11 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
doc/source/conf.py
View File

@ -23,7 +23,8 @@ sys.path.insert(0, os.path.abspath('../..'))
extensions = [
'sphinx.ext.autodoc',
#'sphinx.ext.intersphinx',
'oslosphinx'
'oslosphinx',
'oslo_config.sphinxext',
]
# autodoc generation is a bit aggressive and a nuisance when doing heavy

1
doc/source/index.rst
View File

@ -13,6 +13,7 @@ Contents
installation
api
usage
opts
contributing
history

8
doc/source/opts.rst Normal file
View File

@ -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