Lucian Petrut 0d8b9ec347 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
2019-06-07 16:45:02 +03:00

28 lines
512 B
ReStructuredText

.. cloudbase-init documentation master file, created by
sphinx-quickstart on Wed Jun 03 01:25:56 2015.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to cloudbase-init's documentation!
==========================================
Contents:
.. toctree::
:maxdepth: 2
intro
tutorial
services
plugins
userdata
config
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`