maas-devel team mailing list archive

[Julian Edwards <julian.edwards@xxxxxxxxxxxxx>]

On Tuesday 11 Feb 2014 09:13:03 Raphaël Badin wrote:
> There is a bug for this:
> https://bugs.launchpad.net/maas/+bug/1271694
> 
> (The bug mentions the two problems: the duplication and the fact that
> the documentation is out of date.)

Aha yes I've seen that bug before and had completely forgotten about it.

> We should look into having that man page completely generated from the
> API documentation, possibility with the addition of the existing
> maascli-specific preamble.  It doesn't seem completely reasonable to me
> to have to manually maintain another version of the documentation that
> we already have in the docstrings.

+10000

For some reason I thought we were already doing this.  Auto-doc generation is 
the way forward!

In the meantime we had better write some docs for the zones work.