doc: Integrate oslo_policy.sphinxpolicygen

Change-Id: I80e75b8a592e1125e02ca6177661177a7c17c927

diff --git a/.gitignore b/.gitignore
index ca61a4883f1f6310bd121368eedd46fa90d2c7ca..1baab3825b6ab41607b6496cddf87f2c0356f92d 100644 (file)
--- a/.gitignore
+++ b/.gitignore
@@ -45,6 +45,7 @@ nova/tests/cover/*
 nova/vcsversion.py
 tools/conf/nova.conf*
 doc/source/_static/nova.conf.sample
+doc/source/_static/nova.policy.yaml.sample
 
  # Files created by releasenotes build
 releasenotes/build

diff --git a/doc/source/conf.py b/doc/source/conf.py
index 7249f97c77f0068a5f52f14ee84bf3d5ad04722a..e7c1bb52536f0b10c7b7ee93ff2d1a644a428cdd 100644 (file)
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -34,8 +34,9 @@ extensions = ['sphinx.ext.autodoc',
               'sphinx.ext.coverage',
               'sphinx.ext.graphviz',
               'oslosphinx',
-              "ext.support_matrix",
+              'ext.support_matrix',
               'oslo_config.sphinxconfiggen',
+              'oslo_policy.sphinxpolicygen',
               'ext.versioned_notifications',
               'ext.feature_matrix',
               ]
@@ -43,6 +44,9 @@ extensions = ['sphinx.ext.autodoc',
 config_generator_config_file = '../../etc/nova/nova-config-generator.conf'
 sample_config_basename = '_static/nova'
 
+policy_generator_config_file = '../../etc/nova/nova-policy-generator.conf'
+sample_policy_basename = '_static/nova'
+
 todo_include_todos = True
 
 # The suffix of source filenames.

diff --git a/doc/source/index.rst b/doc/source/index.rst
index d3f93418bce11efd2cdd219db4b98b5d61c1593b..4389cac68ae5de14e94d1d103d1c208ab98330ca 100644 (file)
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -190,6 +190,13 @@ Sample Configuration File
 
     sample_config
 
+Sample Policy file
+------------------
+
+.. toctree::
+    :maxdepth: 1
+
+    sample_policy
 
 Man Pages
 ----------

diff --git a/doc/source/sample_policy.rst b/doc/source/sample_policy.rst
new file mode 100644 (file)
index 0000000..dba4d27
--- /dev/null
+++ b/doc/source/sample_policy.rst
@@ -0,0 +1,12 @@
+===========
+Nova Policy
+===========
+
+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 sample policy can also be viewed in `file form
+<_static/nova.policy.yaml.sample>`_.
+
+.. literalinclude:: _static/nova.policy.yaml.sample