diff options
| author | Doug Hellmann <doug@doughellmann.com> | 2018-04-26 16:59:24 -0400 |
|---|---|---|
| committer | Matt Riedemann <mriedem.os@gmail.com> | 2018-04-30 10:11:21 -0400 |
| commit | 0e7bb2822483cd33798420a143d107b951154172 (patch) | |
| tree | d46f970e408ae862af250577538d71390bd17b0e /doc | |
| parent | c474b36793cbafafe0534bb89a4a33dedbb57142 (diff) | |
| download | oslo-policy-0e7bb2822483cd33798420a143d107b951154172.tar.gz | |
make the sphinxpolicygen extension handle multiple input/output files
Some projects have multiple policy files for different parts of their
API. Make the sample generator extension support this by letting the
policy_generator_config_file option be set to a list of tuples mapping
the config file to the output file base name, as we do in the sample
generator in oslo.config.
Change-Id: I0c7fa409a1ed0f49d65c9b90b71317066f6d3505
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/source/user/sphinxpolicygen.rst | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/source/user/sphinxpolicygen.rst b/doc/source/user/sphinxpolicygen.rst index bf9fc89..e39f70a 100644 --- a/doc/source/user/sphinxpolicygen.rst +++ b/doc/source/user/sphinxpolicygen.rst @@ -27,6 +27,11 @@ where: source directory (``app.srcdir``). If this option is not specified or is invalid then the sample policy file generation will be skipped. + To handle cases where multiple files need to be generated, this + value can be a list of two-part tuples containing the path to the + configuration file and the base name for the output file (in this + case, ``sample_policy_basename`` should not be set). + ``sample_policy_basename`` Base name of the output file. This name will be appended with a ``.policy.yaml.sample`` extension to generate the final output file and the |