update docs for sphinxconfiggen

We landed the feature to let the sphinx integration work with multiple
input and output files, but we didn't update the docs for it.

Change-Id: I1ef3f91aed3bdbcfdff4f8afc5fa325b34008495
Signed-off-by: Doug Hellmann <doug@doughellmann.com>

1 files changed, 33 insertions, 7 deletions

diff --git a/doc/source/sphinxconfiggen.rst b/doc/source/sphinxconfiggen.rst
index 38a1752..5768d73 100644
--- a/doc/source/sphinxconfiggen.rst
+++ b/doc/source/sphinxconfiggen.rst
@@ -12,13 +12,39 @@ the config generator at the config file which tells it how to generate the
 sample config. If one isn't specified or it doesn't point to a real file the
 sample config file generation will be skipped.
 
+To generate multiple files, set ``config_generator_config_file`` to a
+list of tuples containing the input filename and the base name for the
+output file.
+
+The output value can be ``None``, in which case the name is taken from
+the input value.
+
+The input name can be an full path or a value relative to the
+documentation source directory.
+
+For example::
+
+  config_generator_config_file = [
+      ('../../etc/glance-api.conf', 'api'),
+      ('../../etc/glance-cache.conf', 'cache'),
+      ('../../etc/glance-glare.conf', None),
+      ('../../etc/glance-registry.conf', None),
+      ('../../etc/glance-scrubber.conf', None),
+  ]
+
+Produces the output files ``api.conf.sample``, ``cache.conf.sample``,
+``glance-glare.conf.sample``, ``glance-registry.conf.sample``, and
+``glance-scrubber.conf.sample``.
+
 Output File Name
 ----------------
 
-By default the sphinx plugin will generate the sample config file and name the
-file sample.config. However, if for whatever reason you'd like the name to be
-more specific to the project name you can use the ``sample_config_basename``
-config option to specify the project name. If it's set the output filename
-will be that value with a .conf.sample extension. For example if you set that
-to be nova the output filename will be nova.conf.sample. You can also put a
-subdirectory off of the srcdir as part of this value.
+By default the sphinx plugin will generate the sample config file and
+name the file ``sample.config``. However, if for whatever reason you'd
+like the name to be more specific to the project name you can use the
+``sample_config_basename`` config option to specify the project
+name. If it's set the output filename will be that value with a
+``.conf.sample`` extension. For example if you set the value to
+"``nova``" the output filename will be "``nova.conf.sample``". You can
+also include a subdirectory off of the documentation source directory
+as part of this value.