Merge pull request #26 from 4P/moredoc

copy over a bunch of docs from keystone, will probably have to be proofread a bit after

1 files changed, 12 insertions, 12 deletions

diff --git a/keystone/common/cfg.py b/keystone/common/cfg.py
index fd79e122..9551ff79 100644
--- a/keystone/common/cfg.py
+++ b/keystone/common/cfg.py
@@ -17,7 +17,7 @@
 r"""
 Configuration options which may be set on the command line or in config files.
 
-The schema for each option is defined using the Opt sub-classes e.g.
+The schema for each option is defined using the Opt sub-classes e.g.::
 
     common_opts = [
         cfg.StrOpt('bind_host',
@@ -28,7 +28,7 @@ The schema for each option is defined using the Opt sub-classes e.g.
                    help='Port number to listen on')
     ]
 
-Options can be strings, integers, floats, booleans, lists or 'multi strings':
+Options can be strings, integers, floats, booleans, lists or 'multi strings'::
 
     enabled_apis_opt = \
         cfg.ListOpt('enabled_apis',
@@ -43,7 +43,7 @@ Options can be strings, integers, floats, booleans, lists or 'multi strings':
                         default=DEFAULT_EXTENSIONS)
 
 Option schemas are registered with with the config manager at runtime, but
-before the option is referenced:
+before the option is referenced::
 
     class ExtensionManager(object):
 
@@ -59,7 +59,7 @@ before the option is referenced:
                 ....
 
 A common usage pattern is for each option schema to be defined in the module or
-class which uses the option:
+class which uses the option::
 
     opts = ...
 
@@ -74,7 +74,7 @@ class which uses the option:
 
 An option may optionally be made available via the command line. Such options
 must registered with the config manager before the command line is parsed (for
-the purposes of --help and CLI arg validation):
+the purposes of --help and CLI arg validation)::
 
     cli_opts = [
         cfg.BoolOpt('verbose',
@@ -90,7 +90,7 @@ the purposes of --help and CLI arg validation):
     def add_common_opts(conf):
         conf.register_cli_opts(cli_opts)
 
-The config manager has a single CLI option defined by default, --config-file:
+The config manager has a single CLI option defined by default, --config-file::
 
     class ConfigOpts(object):
 
@@ -104,7 +104,7 @@ The config manager has a single CLI option defined by default, --config-file:
 
 Option values are parsed from any supplied config files using SafeConfigParser.
 If none are specified, a default set is used e.g. glance-api.conf and
-glance-common.conf:
+glance-common.conf::
 
     glance-api.conf:
       [DEFAULT]
@@ -119,7 +119,7 @@ are parsed in order, with values in later files overriding those in earlier
 files.
 
 The parsing of CLI args and config files is initiated by invoking the config
-manager e.g.
+manager e.g.::
 
     conf = ConfigOpts()
     conf.register_opt(BoolOpt('verbose', ...))
@@ -127,7 +127,7 @@ manager e.g.
     if conf.verbose:
         ...
 
-Options can be registered as belonging to a group:
+Options can be registered as belonging to a group::
 
     rabbit_group = cfg.OptionGroup(name='rabbit',
                                    title='RabbitMQ options')
@@ -154,7 +154,7 @@ Options can be registered as belonging to a group:
         conf.register_opt(rabbit_ssl_opt, group=rabbit_group)
 
 If no group is specified, options belong to the 'DEFAULT' section of config
-files:
+files::
 
     glance-api.conf:
       [DEFAULT]
@@ -175,7 +175,7 @@ Command-line options in a group are automatically prefixed with the group name:
 
 Option values in the default group are referenced as attributes/properties on
 the config manager; groups are also attributes on the config manager, with
-attributes for each of the options associated with the group:
+attributes for each of the options associated with the group::
 
     server.start(app, conf.bind_port, conf.bind_host, conf)
 
@@ -184,7 +184,7 @@ attributes for each of the options associated with the group:
         port=conf.rabbit.port,
         ...)
 
-Option values may reference other values using PEP 292 string substitution:
+Option values may reference other values using PEP 292 string substitution::
 
     opts = [
         cfg.StrOpt('state_path',