openstack/heat
Code Issues Proposed changes

include sample config file in docs

Browse Source 
Leverage oslo.config to rebuild our sample config file in docs.

Change-Id: I359e63fad43a5fcde4fe30a97cbed8f4f71961c5
This commit is contained in:
ricolin 2017-10-07 02:24:11 +08:00 committed by Zane Bitter
parent fb79011451
commit 46d1e89c27
4 changed files with 22 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
.gitignore vendored
View File

@ -35,3 +35,6 @@ doc/source/_static/heat.policy.yaml.sample
# Files created by releasenotes build # Files created by releasenotes build
releasenotes/build releasenotes/build
# sample config included in docs
doc/source/_static/heat.conf.sample

5
doc/source/conf.py
View File

@ -78,6 +78,7 @@ extensions = ['sphinx.ext.autodoc',
'sphinx.ext.viewcode', 'sphinx.ext.viewcode',
'sphinx.ext.doctest', 'sphinx.ext.doctest',
'openstackdocstheme', 'openstackdocstheme',
'oslo_config.sphinxconfiggen',
'oslo_policy.sphinxext', 'oslo_policy.sphinxext',
'oslo_policy.sphinxpolicygen', 'oslo_policy.sphinxpolicygen',
'ext.resources', 'ext.resources',
@ -88,6 +89,10 @@ extensions = ['sphinx.ext.autodoc',
policy_generator_config_file = '../../etc/heat/heat-policy-generator.conf' policy_generator_config_file = '../../etc/heat/heat-policy-generator.conf'
sample_policy_basename = '_static/heat' sample_policy_basename = '_static/heat'
# oslo_config.sphinxconfiggen options
config_generator_config_file = '../../config-generator.conf'
sample_config_basename = '_static/heat'
# openstackdocstheme options # openstackdocstheme options
repository_name = 'openstack/heat' repository_name = 'openstack/heat'
bug_project = 'heat' bug_project = 'heat'

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

@ -9,4 +9,5 @@ Configuring Heat
clients.rst clients.rst
config-options.rst config-options.rst
logs.rst logs.rst
sample_config.rst
sample_policy.rst sample_policy.rst

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

@ -0,0 +1,12 @@
=========================
Heat Configuration Sample
=========================
The following is a sample heat configuration for adaptation and use. It is
auto-generated from heat when this documentation is built, so if you are
having issues with an option, please compare your version of heat with the
version of this documentation.
The sample configuration can also be downloaded in `file form <../_static/heat.conf.sample>`_.
.. literalinclude:: ../_static/heat.conf.sample