openstack/zun
Code Issues Proposed changes

Add sample policy file to documentation

Browse Source 
Now that Zun has all of its policies registered in code, we can
generate samples to publish in documentation.

bp policy-and-docs-in-code

Change-Id: I8b8efe9bf0af5aef39e293a9ddf9a79da35e5f8f
This commit is contained in:
Lance Bragstad 2017-10-02 20:17:16 +00:00 committed by Hieu LE
parent 8e0e94ba9b
commit ad3dafb3fc
3 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/source/conf.py
View File

@ -25,6 +25,8 @@ extensions = [
'sphinx.ext.graphviz', 'sphinx.ext.graphviz',
'openstackdocstheme', 'openstackdocstheme',
'oslo_config.sphinxconfiggen', 'oslo_config.sphinxconfiggen',
'oslo_policy.sphinxext',
'oslo_policy.sphinxpolicygen',
] ]
# autodoc generation is a bit aggressive and a nuisance when doing heavy # autodoc generation is a bit aggressive and a nuisance when doing heavy
@ -45,6 +47,9 @@ bug_tag = ''
config_generator_config_file = '../../etc/zun/zun-config-generator.conf' config_generator_config_file = '../../etc/zun/zun-config-generator.conf'
sample_config_basename = '_static/zun' sample_config_basename = '_static/zun'
policy_generator_config_file = '../../etc/zun/zun-policy-generator.conf'
sample_policy_basename = '_static/zun'
# General information about the project. # General information about the project.
project = u'zun' project = u'zun'
copyright = u'2013, OpenStack Foundation' copyright = u'2013, OpenStack Foundation'

1
doc/source/configuration/index.rst
View File

@ -5,3 +5,4 @@ Sample Configuration File
:maxdepth: 1 :maxdepth: 1
sample-config sample-config
policy

12
doc/source/configuration/policy.rst Normal file
View File

@ -0,0 +1,12 @@
====================
Policy configuration
====================
Configuration
~~~~~~~~~~~~~
The following is an overview of all available policies in Zun. For a sample
configuration file.
.. show-policy::
:config-file: ../../etc/zun/zun-policy-generator.conf