From cc33b397092986ce0d195dbe1edd55b189c6acab Mon Sep 17 00:00:00 2001 From: Davanum Srinivas Date: Fri, 25 Sep 2015 06:53:01 -0400 Subject: [PATCH] add auto-generated docs for config options Add automatically generated documentation for the configuration options using oslo_config.sphinxext. Change-Id: I9525a637bc284beaf22e48e80b5c2f8ba7872a8e --- doc/source/conf.py | 3 ++- doc/source/index.rst | 1 + doc/source/opts.rst | 8 ++++++++ 3 files changed, 11 insertions(+), 1 deletion(-) create mode 100644 doc/source/opts.rst diff --git a/doc/source/conf.py b/doc/source/conf.py index b0bfee6..7d01683 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -23,7 +23,8 @@ sys.path.insert(0, os.path.abspath('../..')) 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 bd7c001..c1208be 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -13,6 +13,7 @@ Contents installation api usage + opts contributing history diff --git a/doc/source/opts.rst b/doc/source/opts.rst new file mode 100644 index 0000000..205e30d --- /dev/null +++ b/doc/source/opts.rst @@ -0,0 +1,8 @@ +======================= + Configuration Options +======================= + +oslo.reports uses oslo.config to define and manage configuration options +to allow the deployer to control where the GMR reports should be generated. + +.. show-options:: oslo.reports