[chef] Re: Chef cookbook documentation generator from attributes files

[Peter Donald < >]

Hi,

On Fri, Oct 11, 2013 at 2:09 AM, Ionuț Arțăriși 
<
 >
 wrote:
> I am aware of other tools which generate documentation from cookbook
> filse, but they either do not use the attributes file as a source or
> ignore comments.

The "knife cookbook doc" plugin [1] will scan the attributes directory
to generate the README in much the same way. It also scans the recipes
directory to build documentation for recipes from the code, LWRPs as
well. It also allows you to mix in markdown from another location (ie.
doc/overview.md).

You can see an example of the generated readme at [2] from annotated
source files.

[1] https://github.com/realityforge/knife-cookbook-doc
[2] https://github.com/realityforge/chef-glassfish

-- 
Cheers,

Peter Donald