From 5c9d0d4511068981d6036d21928829d6defb35de Mon Sep 17 00:00:00 2001 From: Joshua Harlow Date: Thu, 24 Sep 2015 11:32:01 -0700 Subject: [PATCH] add auto-generated docs for config options Add automatically generated documentation for the configuration options using oslo_config.sphinxext. Change-Id: Ie698129e855dd35b2d0a4a1be625c2137f15f5e7 --- doc/source/conf.py | 4 ++-- doc/source/index.rst | 1 + doc/source/opts.rst | 36 ++++++++++++++++++++++++++++++++++++ 3 files changed, 39 insertions(+), 2 deletions(-) create mode 100644 doc/source/opts.rst diff --git a/doc/source/conf.py b/doc/source/conf.py index 848d1bb0..9209e6e9 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -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 diff --git a/doc/source/index.rst b/doc/source/index.rst index 538b5852..acce54c4 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -9,6 +9,7 @@ Library for running OpenStack services installation usage + opts contributing history diff --git a/doc/source/opts.rst b/doc/source/opts.rst new file mode 100644 index 00000000..3a532d44 --- /dev/null +++ b/doc/source/opts.rst @@ -0,0 +1,36 @@ +======================= + Configuration Options +======================= + +oslo.service uses oslo.config to define and manage configuration options +to allow the deployer to control how an application uses this library. + +periodic_task +============= + +These options apply to services using the periodic task features of +oslo.service. + +.. show-options:: oslo.service.periodic_task + +service +======= + +These options apply to services using the basic service framework. + +.. show-options:: oslo.service.service + +sslutils +======== + +These options apply to services using the SSL utilities module. + +.. show-options:: oslo.service.sslutils + +wsgi +==== + +These options apply to services using the WSGI (Web Service Gateway +Interface) module. + +.. show-options:: oslo.service.wsgi