openstack/oslo.cache
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: Ic8372b14cf5bbe423d098f4bb9cf4536c9336c2f
This commit is contained in:
Joshua Harlow 2015-09-24 12:31:11 -07:00
parent 8d9cdbb0fd
commit 140f337779
3 changed files with 11 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/source/conf.py
View File

@ -22,8 +22,8 @@ sys.path.insert(0, os.path.abspath('../..'))
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
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/modules
usage
opts
contributing
history

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

@ -0,0 +1,8 @@
=======================
Configuration Options
=======================
oslo.cache uses oslo.config to define and manage configuration options
to allow the deployer to control how an application uses this library.
.. show-options:: oslo.cache