diff --git a/doc/source/conf.py b/doc/source/conf.py index 11bf8ef4c..ecbffa368 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -24,6 +24,7 @@ extensions = [ 'sphinx.ext.autodoc', 'sphinx.ext.graphviz', 'openstackdocstheme', + 'oslo_config.sphinxconfiggen', ] # autodoc generation is a bit aggressive and a nuisance when doing heavy @@ -41,6 +42,9 @@ repository_name = 'openstack/zun' bug_project = 'zun' bug_tag = '' +config_generator_config_file = '../../etc/zun/zun-config-generator.conf' +sample_config_basename = '_static/zun' + # General information about the project. project = u'zun' copyright = u'2013, OpenStack Foundation' diff --git a/doc/source/configuration/sample-config.rst b/doc/source/configuration/sample-config.rst new file mode 100644 index 000000000..4db0f1039 --- /dev/null +++ b/doc/source/configuration/sample-config.rst @@ -0,0 +1,13 @@ +========================= +Zun Configuration Options +========================= + +The following is a sample Zun configuration for adaptation and use. It is +auto-generated from Zun when this documentation is built, so +if you are having issues with an option, please compare your version of +Zun with the version of this documentation. + +The sample configuration can also be viewed in :download:`file form +`. + +.. literalinclude:: /_static/zun.conf.sample diff --git a/doc/source/index.rst b/doc/source/index.rst index 83a1f7c77..53b6f8643 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -32,6 +32,21 @@ Contributor Guide contributor/index +Installation Guide +------------------ +.. toctree:: + :maxdepth: 1 + + install/index + +Sample Configuration File +------------------------- + +.. toctree:: + :maxdepth: 1 + + configuration/sample-config + Indices and tables ------------------ diff --git a/doc/source/install/index.rst b/doc/source/install/index.rst new file mode 100644 index 000000000..119bb1943 --- /dev/null +++ b/doc/source/install/index.rst @@ -0,0 +1,6 @@ +====================== +Zun Installation Guide +====================== + +TODO: There is currently no installation guide for Zun. The work will be +tracked here: https://blueprints.launchpad.net/zun/+spec/zun-installation-guide diff --git a/etc/zun/policy.yaml.sample b/etc/zun/policy.yaml.sample new file mode 100644 index 000000000..e69de29bb