diff options
| author | Joshua Harlow <harlowja@yahoo-inc.com> | 2015-09-24 11:27:07 -0700 |
|---|---|---|
| committer | Joshua Harlow <harlowja@yahoo-inc.com> | 2015-09-24 11:31:19 -0700 |
| commit | 933669ce29fda6cae56fb75717eb5755a9e08fba (patch) | |
| tree | add3c51b5279b0053ca5bde4a0f5f09d38394707 /doc | |
| parent | 722910a8243476a0ad9b93329556fb891659ccab (diff) | |
| download | oslo-concurrency-933669ce29fda6cae56fb75717eb5755a9e08fba.tar.gz | |
add auto-generated docs for config options
Add automatically generated documentation for the configuration options
using oslo_config.sphinxext.
Change-Id: If7eb94b268bb82e0fcfbac9dfd231ea25ff53b24
Diffstat (limited to 'doc')
| -rwxr-xr-x | doc/source/conf.py | 4 | ||||
| -rw-r--r-- | doc/source/index.rst | 1 | ||||
| -rw-r--r-- | doc/source/opts.rst | 8 |
3 files changed, 11 insertions, 2 deletions
diff --git a/doc/source/conf.py b/doc/source/conf.py index edd0343..a35d5a5 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -24,8 +24,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 diff --git a/doc/source/index.rst b/doc/source/index.rst index 9619d10..398d4e1 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -11,6 +11,7 @@ external processes. installation usage + opts contributing history diff --git a/doc/source/opts.rst b/doc/source/opts.rst new file mode 100644 index 0000000..27ee4fb --- /dev/null +++ b/doc/source/opts.rst @@ -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 |