One major item that I'm missing from 'puppet doc' is the ability to output data for everything in your module tree at the same time.
I'd like to see output for classes, defines, custom types, and custom functions output consistently from one tool in a way that is easy to translate to other formats. I'd like to support: HTML Multi-Page, HTML Single Page, and PDF that can easily be incorporated into other documentation sets. As painful as it is, an XML format with XSLT works extremely well for this. For a standard...Docbook would be great to support. Thanks, Trevor On Sat, Apr 20, 2013 at 2:23 PM, Henrik Lindberg < [email protected]> wrote: > On 2013-19-04 23:55, Erik Dalén wrote: > >> But unfortunately the rdoc style is extremely verbose and cumbersome to >> write and maintain. >> There is pocco as well: >> http://nanliu.github.io/**puppet-pocco/<http://nanliu.github.io/puppet-pocco/> >> >> And there is Geppetto that creates a model of the source (including > documentation) and it formats documentation in HTML for viewing inside > Geppetto (on hover over elements). (Could easily make it write the HTML to > a file) > > > But some tool like yardoc for puppet would be pretty nice IMO. >> >> What aspects of Yardoc do you find most interesting? > > Instead of relying on an external tool (rdoc or yard) there needs to be a > specific puppet doc specification and tool/generator. That way it is > probably possible to maintain reasonable backwards compatibility as well as > support the various downstream use cases more easily. > > Using the rdoc or yard implementations will continue to have issues as > they are targeting generation of docs for Ruby. > > Regards > - henrik > > >> On 19 April 2013 12:43, Johan De Wit <[email protected] >> <mailto:[email protected]>> wrote: >> >> On 04/19/2013 03:09 AM, Rags wrote: >> >> From what I read, there is no way to add descriptions (baring >> putting a comment) to class parameters. This would be good to >> have. Especially in a way that external tools can >> programmatically get hold of parameter list along with >> descriptions... >> >> Thanks Rags >> -- >> You received this message because you are subscribed to the >> Google Groups "Puppet Developers" group. >> To unsubscribe from this group and stop receiving emails from >> it, send an email to >> puppet-dev+unsubscribe@__googl**egroups.com<http://googlegroups.com> >> >> <mailto:puppet-dev%**[email protected]<puppet-dev%[email protected]> >> **>. >> >> To post to this group, send email to [email protected] >> <mailto:puppet-dev@**googlegroups.com<[email protected]> >> >. >> Visit this group at >> >> http://groups.google.com/__**group/puppet-dev?hl=en<http://groups.google.com/__group/puppet-dev?hl=en> >> >> <http://groups.google.com/**group/puppet-dev?hl=en<http://groups.google.com/group/puppet-dev?hl=en> >> >. >> For more options, visit >> >> https://groups.google.com/__**groups/opt_out<https://groups.google.com/__groups/opt_out> >> >> <https://groups.google.com/**groups/opt_out<https://groups.google.com/groups/opt_out> >> >. >> >> >> >> The style guides describes the preferred way to document your classes >> : >> >> >> http://docs.puppetlabs.com/__**guides/style_guide.html#__**puppet-doc<http://docs.puppetlabs.com/__guides/style_guide.html#__puppet-doc> >> >> >> <http://docs.puppetlabs.com/**guides/style_guide.html#**puppet-doc<http://docs.puppetlabs.com/guides/style_guide.html#puppet-doc> >> > >> >> -- >> Johan De Wit >> >> Open Source Consultant >> Red Hat Certified Engineer (805008667232363) >> Puppet Certified Professional 2013 (PCP0000006) >> ______________________________**_____________________________ >> >> >> Open-Future Phone +32 (0)2/255 70 70 >> <tel:%2B32%20%280%292%2F255%**2070%2070> >> >> Zavelstraat 72 Fax +32 (0)2/255 70 71 >> <tel:%2B32%20%280%292%2F255%**2070%2071> >> >> 3071 KORTENBERG Mobile +32 (0)474/42 40 73 >> <tel:%2B32%20%280%29474%2F42%**2040%2073> >> BELGIUM http://www.open-future.be >> ______________________________**_____________________________ >> >> >> >> -- >> You received this message because you are subscribed to the Google >> Groups "Puppet Developers" group. >> To unsubscribe from this group and stop receiving emails from it, >> send an email to >> puppet-dev+unsubscribe@__googl**egroups.com<http://googlegroups.com> >> >> <mailto:puppet-dev%**[email protected]<puppet-dev%[email protected]> >> **>. >> >> To post to this group, send email to [email protected] >> <mailto:puppet-dev@**googlegroups.com <[email protected]>>. >> Visit this group at >> >> http://groups.google.com/__**group/puppet-dev?hl=en<http://groups.google.com/__group/puppet-dev?hl=en> >> >> <http://groups.google.com/**group/puppet-dev?hl=en<http://groups.google.com/group/puppet-dev?hl=en> >> >. >> For more options, visit >> https://groups.google.com/__**groups/opt_out<https://groups.google.com/__groups/opt_out> >> >> <https://groups.google.com/**groups/opt_out<https://groups.google.com/groups/opt_out> >> >. >> >> >> >> >> >> >> -- >> Erik Dalén >> >> -- >> You received this message because you are subscribed to the Google >> Groups "Puppet Developers" group. >> To unsubscribe from this group and stop receiving emails from it, send >> an email to >> puppet-dev+unsubscribe@**googlegroups.com<puppet-dev%[email protected]> >> . >> To post to this group, send email to [email protected]. >> Visit this group at >> http://groups.google.com/**group/puppet-dev?hl=en<http://groups.google.com/group/puppet-dev?hl=en> >> . >> For more options, visit >> https://groups.google.com/**groups/opt_out<https://groups.google.com/groups/opt_out> >> . >> >> >> > > -- > You received this message because you are subscribed to the Google Groups > "Puppet Developers" group. > To unsubscribe from this group and stop receiving emails from it, send an > email to > puppet-dev+unsubscribe@**googlegroups.com<puppet-dev%[email protected]> > . > To post to this group, send email to [email protected]. > Visit this group at > http://groups.google.com/**group/puppet-dev?hl=en<http://groups.google.com/group/puppet-dev?hl=en> > . > For more options, visit > https://groups.google.com/**groups/opt_out<https://groups.google.com/groups/opt_out> > . > > > -- Trevor Vaughan Vice President, Onyx Point, Inc (410) 541-6699 [email protected] -- This account not approved for unencrypted proprietary information -- -- You received this message because you are subscribed to the Google Groups "Puppet Developers" group. To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. To post to this group, send email to [email protected]. Visit this group at http://groups.google.com/group/puppet-dev?hl=en. For more options, visit https://groups.google.com/groups/opt_out.
