doc: Integrate oslo_policy.sphinxpolicygen

Change-Id: I80e75b8a592e1125e02ca6177661177a7c17c927
This commit is contained in:
Stephen Finucane 2016-09-26 14:53:18 +01:00
parent f3d535b862
commit 864f65e4fd
4 changed files with 25 additions and 1 deletions

1
.gitignore vendored
View File

@ -45,6 +45,7 @@ nova/tests/cover/*
nova/vcsversion.py nova/vcsversion.py
tools/conf/nova.conf* tools/conf/nova.conf*
doc/source/_static/nova.conf.sample doc/source/_static/nova.conf.sample
doc/source/_static/nova.policy.yaml.sample
# Files created by releasenotes build # Files created by releasenotes build
releasenotes/build releasenotes/build

View File

@ -34,8 +34,9 @@ extensions = ['sphinx.ext.autodoc',
'sphinx.ext.coverage', 'sphinx.ext.coverage',
'sphinx.ext.graphviz', 'sphinx.ext.graphviz',
'oslosphinx', 'oslosphinx',
"ext.support_matrix", 'ext.support_matrix',
'oslo_config.sphinxconfiggen', 'oslo_config.sphinxconfiggen',
'oslo_policy.sphinxpolicygen',
'ext.versioned_notifications', 'ext.versioned_notifications',
'ext.feature_matrix', 'ext.feature_matrix',
] ]
@ -43,6 +44,9 @@ extensions = ['sphinx.ext.autodoc',
config_generator_config_file = '../../etc/nova/nova-config-generator.conf' config_generator_config_file = '../../etc/nova/nova-config-generator.conf'
sample_config_basename = '_static/nova' sample_config_basename = '_static/nova'
policy_generator_config_file = '../../etc/nova/nova-policy-generator.conf'
sample_policy_basename = '_static/nova'
todo_include_todos = True todo_include_todos = True
# The suffix of source filenames. # The suffix of source filenames.

View File

@ -190,6 +190,13 @@ Sample Configuration File
sample_config sample_config
Sample Policy file
------------------
.. toctree::
:maxdepth: 1
sample_policy
Man Pages Man Pages
---------- ----------

View File

@ -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