docs: add automatically generated list of cfg opts
This change will include an automatically generated list of config options in the cloudbase-init docs. It's useful as some config options are not currently mentioned in the docs and it's also nice to be able to have a quick overview of all available options without having to go through the code. You can also send links to certain config options or groups. Note that long config opt lines are not wrapped and look quite bad, especially with the current theme (may consider switching to some other theme, maybe the "alabaster" one included by default by sphinx). Still better than not having this at all though. We're also adding the zuul jobs that validate release notes and docs, required for testing this patch. Change-Id: Ibaff3a91e7f1345aaaac0c29b995e7c25b9e4669
This commit is contained in:
parent
11be98ebe3
commit
0d8b9ec347
@ -1,4 +1,12 @@
|
||||
- project:
|
||||
check:
|
||||
jobs:
|
||||
- build-openstack-releasenotes
|
||||
- build-openstack-sphinx-docs
|
||||
gate:
|
||||
jobs:
|
||||
- build-openstack-releasenotes
|
||||
- build-openstack-sphinx-docs
|
||||
post:
|
||||
jobs:
|
||||
- cbsl-init-upload-git-mirror
|
||||
|
@ -32,6 +32,8 @@ import shlex
|
||||
extensions = [
|
||||
'sphinx.ext.autodoc',
|
||||
'sphinx.ext.viewcode',
|
||||
'oslo_config.sphinxext'
|
||||
|
||||
]
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
|
13
doc/source/config.rst
Normal file
13
doc/source/config.rst
Normal file
@ -0,0 +1,13 @@
|
||||
.. _config_list:
|
||||
|
||||
===============================
|
||||
Configuration options reference
|
||||
===============================
|
||||
|
||||
The following is an overview of all available configuration options in
|
||||
cloudbase-init.
|
||||
|
||||
.. show-options::
|
||||
|
||||
cloudbaseinit.conf
|
||||
oslo.log
|
@ -16,6 +16,7 @@ Contents:
|
||||
services
|
||||
plugins
|
||||
userdata
|
||||
config
|
||||
|
||||
|
||||
Indices and tables
|
||||
|
@ -93,6 +93,7 @@ initialization cases.
|
||||
More of these explained options are available under the :ref:`services`,
|
||||
:ref:`plugins` and :ref:`userdata` documentation.
|
||||
|
||||
A complete list of config options can be found at :ref:`config_list`.
|
||||
|
||||
.. _execution:
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user