openstack/oslo.concurrency
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: If7eb94b268bb82e0fcfbac9dfd231ea25ff53b24
This commit is contained in:
Joshua Harlow 2015-09-24 11:27:07 -07:00
parent 722910a824
commit 933669ce29
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

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

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

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