cloud-init-dev team mailing list archive

[Chad Smith <chad.smith@xxxxxxxxxxxxx>]

The proposal to merge ~chad.smith/cloud-init:schema-autodoc into cloud-init:master has been updated.

Commit Message changed to:

docs: Automatically generate module docs form schema attribute if present

We have started adding jsonschema definitions for cloudconfig modules (cc_ntp). This branch allows us render sphinx docs using the module's shema definition instead of using the module's docstring.
This allows us to avoid duplicating schema documentation in the module-level docstring and schema definition. The corresponding module documentation is extended a bit to differentiate between config schema and potential examples.

For more details, see:
https://code.launchpad.net/~chad.smith/cloud-init/+git/cloud-init/+merge/325507
-- 
Your team cloud-init commiters is requested to review the proposed merge of ~chad.smith/cloud-init:schema-autodoc into cloud-init:master.