add built-in options to auto-generated documentation
Change-Id: I06d3c4bd18d06d474fd16f7c921ebcf5abb40c59
This commit is contained in:
parent
d5f877ed0e
commit
30a75eb44d
|
@ -0,0 +1,5 @@
|
||||||
|
==================
|
||||||
|
Built-in Options
|
||||||
|
==================
|
||||||
|
|
||||||
|
.. show-options:: oslo.config
|
|
@ -9,7 +9,8 @@ sys.path.insert(0, os.path.abspath('../..'))
|
||||||
# Add any Sphinx extension module names here, as strings. They can be
|
# Add any Sphinx extension module names here, as strings. They can be
|
||||||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
||||||
extensions = ['sphinx.ext.autodoc', 'oslosphinx',
|
extensions = ['sphinx.ext.autodoc', 'oslosphinx',
|
||||||
'oslo_config.sphinxconfiggen']
|
'oslo_config.sphinxconfiggen',
|
||||||
|
'oslo_config.sphinxext']
|
||||||
|
|
||||||
config_generator_config_file = 'config-generator.conf'
|
config_generator_config_file = 'config-generator.conf'
|
||||||
|
|
||||||
|
|
|
@ -24,6 +24,7 @@ Contents
|
||||||
generator
|
generator
|
||||||
faq
|
faq
|
||||||
contributing
|
contributing
|
||||||
|
builtins
|
||||||
sphinxconfiggen
|
sphinxconfiggen
|
||||||
|
|
||||||
Release Notes
|
Release Notes
|
||||||
|
|
|
@ -83,7 +83,8 @@ def _format_defaults(opt):
|
||||||
elif isinstance(opt, (cfg.IntOpt, cfg.FloatOpt,
|
elif isinstance(opt, (cfg.IntOpt, cfg.FloatOpt,
|
||||||
cfg.PortOpt)):
|
cfg.PortOpt)):
|
||||||
default_str = str(opt.default)
|
default_str = str(opt.default)
|
||||||
elif isinstance(opt, cfg.ListOpt):
|
elif isinstance(opt, (cfg.ListOpt, cfg._ConfigFileOpt,
|
||||||
|
cfg._ConfigDirOpt)):
|
||||||
default_str = ','.join(opt.default)
|
default_str = ','.join(opt.default)
|
||||||
elif isinstance(opt, cfg.DictOpt):
|
elif isinstance(opt, cfg.DictOpt):
|
||||||
sorted_items = sorted(opt.default.items(),
|
sorted_items = sorted(opt.default.items(),
|
||||||
|
|
|
@ -62,6 +62,8 @@ class ShowOptionsDirective(rst.Directive):
|
||||||
cfg.ListOpt: 'list',
|
cfg.ListOpt: 'list',
|
||||||
cfg.DictOpt: 'dict',
|
cfg.DictOpt: 'dict',
|
||||||
cfg.MultiStrOpt: 'multi-valued',
|
cfg.MultiStrOpt: 'multi-valued',
|
||||||
|
cfg._ConfigFileOpt: 'list of filenames',
|
||||||
|
cfg._ConfigDirOpt: 'list of directory names',
|
||||||
}
|
}
|
||||||
|
|
||||||
def run(self):
|
def run(self):
|
||||||
|
|
Loading…
Reference in New Issue