diff --git a/.zuul.yaml b/.zuul.yaml index b7cefb38..2cc516b9 100644 --- a/.zuul.yaml +++ b/.zuul.yaml @@ -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 diff --git a/doc/source/conf.py b/doc/source/conf.py index 3a9714bf..211c6617 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -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. diff --git a/doc/source/config.rst b/doc/source/config.rst new file mode 100644 index 00000000..f18af579 --- /dev/null +++ b/doc/source/config.rst @@ -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 diff --git a/doc/source/index.rst b/doc/source/index.rst index e46020d4..71306b2f 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -16,6 +16,7 @@ Contents: services plugins userdata + config Indices and tables diff --git a/doc/source/tutorial.rst b/doc/source/tutorial.rst index 6bc012b0..a36a9eca 100644 --- a/doc/source/tutorial.rst +++ b/doc/source/tutorial.rst @@ -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: