openstack/oslo.policy
Code Issues Proposed changes

add auto-generated docs for config options

Browse Source 
Add automatically generated documentation for the configuration options
using oslo_config.sphinxext.

Change-Id: I18faeb6c32dec69d3ecb4986317cada2af3632f8
This commit is contained in:
Davanum Srinivas 2015-09-25 06:48:51 -04:00
parent 288fefb651
commit 2f5038b712
3 changed files with 12 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 = [ 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

1
doc/source/index.rst
View File

@ -11,6 +11,7 @@ Contents
installation installation
api/modules api/modules
usage usage
opts
contributing contributing
history history

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

@ -0,0 +1,9 @@
=======================
Configuration Options
=======================
oslo.policy uses oslo.config to define and manage configuration options
to allow the deployer to control where the policy files are located and
the default rule to apply when policy etc.
.. show-options:: oslo.policy