Document config parameters

Use oslo.config Sphinx extension to document all
config parameters.

Change-Id: Id934e8fac689d8cdbcc2d59663efdfcf1573e8ab

doc/source/conf.py

@@ -24,8 +24,12 @@ sys.path.insert(0, os.path.abspath('../..'))
 extensions = [
     'sphinx.ext.autodoc',
     'sphinxcontrib.httpdomain',
+    'oslo_config.sphinxconfiggen',
+    'oslo_config.sphinxext',
 ]
 
+# config_generator_config_file = 'config-generator.conf'
+
 # autodoc generation is a bit aggressive and a nuisance when doing heavy
 # text edit cycles.
 # execute "export SPHINX_DEBUG=1" in your terminal to disable

doc/source/config.rst

@@ -0,0 +1,8 @@
+.. _config:
+
+========================
+Shaker config parameters
+========================
+
+.. show-options::
+   :config-file: config-generator.conf

doc/source/index.rst

@@ -21,4 +21,5 @@ to execute. Additionally tests may be tuned dynamically in command-line.
     examples/index
     examples_spot
     reports/index
+    config
     contributing

doc/source/usage.rst

@@ -13,7 +13,8 @@ The config can be passed to Shaker rather by sourcing into system env ``source o
 or via set of CLI parameters ``--os-project-name``, ``--os-username``, ``--os-password``,
 ``--os-auth-url`` and ``--os-region-name``.
 Connection to SSL endpoints is configured by parameters ``--os-cacert`` and ``--os-insecure``
-(to disable certificate verification).
+(to disable certificate verification). Configuration can also be specified in
+config file, refer to :ref:`config`. Config file name can be passed by parameter ``--config-file``.
 
 .. note::
     Shaker is better run under user with admin privileges. However, it's possible