diff --git a/doc/source/conf.py b/doc/source/conf.py index a45e0f4500b5..d6c5928f8c99 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -42,6 +42,7 @@ extensions = ['sphinx.ext.autodoc', 'oslo_config.sphinxconfiggen', 'oslo_config.sphinxext', 'oslo_policy.sphinxpolicygen', + 'oslo_policy.sphinxext', 'ext.versioned_notifications', 'ext.feature_matrix', ] diff --git a/doc/source/configuration/policy.rst b/doc/source/configuration/policy.rst new file mode 100644 index 000000000000..8fea1406e5c0 --- /dev/null +++ b/doc/source/configuration/policy.rst @@ -0,0 +1,9 @@ +======== +Policies +======== + +The following is an overview of all available policies in Nova. For a sample +configuration file, refer to :doc:`/configuration/sample-policy`. + +.. show-policy:: + :config-file: etc/nova/nova-policy-generator.conf diff --git a/doc/source/configuration/sample-policy.rst b/doc/source/configuration/sample-policy.rst index acf67dfb626b..0e4b699af792 100644 --- a/doc/source/configuration/sample-policy.rst +++ b/doc/source/configuration/sample-policy.rst @@ -1,12 +1,16 @@ -=========== -Nova Policy -=========== +================== +Sample Policy File +================== -The following is a sample nova policy file, autogenerated from nova when this -documentation is built. To prevent conflicts, ensure your version of nova -aligns with the version of this documentation. +The following is a sample nova policy file for adaptation and use. The sample policy can also be viewed in :download:`file form `. +.. important:: + + The sample policy file is auto-generated from nova when this documentation + is built. You must ensure your version of nova matches the version of this + documentation. + .. literalinclude:: /_static/nova.policy.yaml.sample diff --git a/doc/source/index.rst b/doc/source/index.rst index c7fe6d2b7987..46bae298f7f5 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -203,12 +203,13 @@ Configuration configuration/config configuration/sample-config -Sample Policy file ------------------- +Policy +------ .. toctree:: :maxdepth: 1 + configuration/policy configuration/sample-policy Man Pages