Merge "add built-in options to auto-generated documentation"

doc/source/builtins.rst

@@ -0,0 +1,5 @@
+==================
+ Built-in Options
+==================
+
+.. show-options:: oslo.config

doc/source/conf.py

@@ -10,7 +10,8 @@ sys.path.insert(0, os.path.abspath('../..'))
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 extensions = ['sphinx.ext.autodoc', 'oslosphinx',
-              'oslo_config.sphinxconfiggen']
+              'oslo_config.sphinxconfiggen',
+              'oslo_config.sphinxext']
 
 config_generator_config_file = 'config-generator.conf'
 

doc/source/index.rst

@@ -24,6 +24,7 @@ Contents
    generator
    faq
    contributing
+   builtins
    sphinxconfiggen
 
 Release Notes

oslo_config/generator.py

@@ -83,7 +83,8 @@ def _format_defaults(opt):
         elif isinstance(opt, (cfg.IntOpt, cfg.FloatOpt,
                               cfg.PortOpt)):
             default_str = str(opt.default)
-        elif isinstance(opt, cfg.ListOpt):
+        elif isinstance(opt, (cfg.ListOpt, cfg._ConfigFileOpt,
+                              cfg._ConfigDirOpt)):
             default_str = ','.join(opt.default)
         elif isinstance(opt, cfg.DictOpt):
             sorted_items = sorted(opt.default.items(),

oslo_config/sphinxext.py

@@ -62,6 +62,8 @@ class ShowOptionsDirective(rst.Directive):
         cfg.ListOpt: 'list',
         cfg.DictOpt: 'dict',
         cfg.MultiStrOpt: 'multi-valued',
+        cfg._ConfigFileOpt: 'list of filenames',
+        cfg._ConfigDirOpt: 'list of directory names',
     }
 
     def run(self):