openstack/nova
Code Issues Proposed changes

doc: Start using oslo_config.sphinxext

Browse Source 
Providing a sample configuration file is all well and good, but it's not
exactly designed for readability on the web. Make use of the 'sphinxext'
module built into oslo.config to do this.

Change-Id: I75e8f0adae7cfaaa6020870cdb20dc2144fc70eb
This commit is contained in:
Stephen Finucane 2017-08-03 16:24:53 +01:00 committed by Matt Riedemann
parent cf52fc21cc
commit 83a9c2ac33
4 changed files with 25 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/source/conf.py
View File

@ -40,6 +40,7 @@ extensions = ['sphinx.ext.autodoc',
'sphinx.ext.graphviz',
'ext.support_matrix',
'oslo_config.sphinxconfiggen',
'oslo_config.sphinxext',
'oslo_policy.sphinxpolicygen',
'ext.versioned_notifications',
'ext.feature_matrix',

9
doc/source/configuration/config.rst Normal file
View File

@ -0,0 +1,9 @@
=====================
Configuration Options
=====================
The following is an overview of all available configuration options in Nova.
For a sample configuration file, refer to :doc:`/configuration/sample-config`.
.. show-options::
:config-file: etc/nova/nova-config-generator.conf

19
doc/source/configuration/sample-config.rst
View File

@ -1,13 +1,18 @@
==========================
Nova Configuration Options
==========================
=========================
Sample Configuration File
=========================
The following is a sample Nova configuration for adaptation and use. It is
auto-generated from Nova when this documentation is built, so
if you are having issues with an option, please compare your version of
Nova with the version of this documentation.
The following is a sample nova configuration for adaptation and use. For a
detailed overview of all available configuration options, refer to
:doc:`/configuration/config`.
The sample configuration can also be viewed in :download:`file form
</_static/nova.conf.sample>`.
.. important::
The sample configuration file is auto-generated from nova when this
documentation is built. You must ensure your version of nova matches the
version of this documentation.
.. literalinclude:: /_static/nova.conf.sample

5
doc/source/index.rst
View File

@ -194,12 +194,13 @@ Advanced testing and guides
contributor/testing/serial-console
contributor/testing/zero-downtime-upgrade
Sample Configuration File
-------------------------
Configuration
-------------
.. toctree::
:maxdepth: 1
configuration/config
configuration/sample-config
Sample Policy file