openstack/oslo.db
Code Issues Proposed changes

Add config options to the documentation

Browse Source 
Add the directive to include the configuration options
to the library documentation.

Change-Id: I085cf62213340e19a2fa39b909b5c0365226f059
This commit is contained in:
Davanum Srinivas 2015-09-24 07:49:23 -04:00
parent 7daffffafc
commit 6450edb58b
3 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/source/conf.py
View File

@ -22,6 +22,7 @@ sys.path.insert(0, os.path.abspath('../..'))
extensions = [
'sphinx.ext.autodoc',
#'sphinx.ext.intersphinx',
'oslo_config.sphinxext',
'oslosphinx'
]

1
doc/source/index.rst
View File

@ -9,6 +9,7 @@ to different database backends and various other helper utils.
:maxdepth: 2
installation
opts
usage
contributing
history

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

@ -0,0 +1,9 @@
=====================
Configuration Options
=====================
oslo.db uses oslo.config to define and manage configuration
options to allow the deployer to control how an application uses the
underlying database.
.. show-options:: oslo.db