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.

Description changed to:

docs: Automatically generate module docs form schema attribute if present

We have started adding jsonschema defintions 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.
It allows us to generate our module documentation directly from the schema definition and avoid duplicating that documentation in the module-level docstring. The corresponding module documentation is extended a bit to differentiate between config schema and potential examples.

To test:
   tox -e docs
   xdg-open doc/rtd_html/topics/modules.html # look over the cc_ntp module
   # merge this branch and remove part of the module docstring  cloudinit/config/cc_ntp.py
   tox -e docs
   xdg-open doc/rtd_html/topics/modules.html  # to view the differences in styling and content of cc_ntp

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.