Note
This extension relies on oslopolicy-sample-generator, which requires configuration of policies in code to function. Refer to the Usage guide for more information.
oslo.policy includes a sphinx extension to generate a sample policy file at the beginning of each sphinx build. This sample policy file can then be included in your documents as a raw file, for example, via the literalinclude directive.
To activate the extension add oslo_policy.sphinxpolicygen to the list of extensions in your sphinx conf.py. Once enabled, you need to define two options: policy_generator_config_file and sample_policy_basename. For example:
policy_generator_config_file = '../../etc/nova/nova-policy-generator.conf'
sample_policy_basename = '_static/nova'
where:
Once configured, you can include this configuration file in your source:
=============
Sample Policy
=============
Here is a sample policy file.
.. literalinclude:: _static/nova.policy.yaml.sample