Puppet users - Apr 2013 - Generate YARD docs for modulepath

Hi, Puppet 3.1 now uses YARD to generate its API documentation. Is anybody 
aware of the possibility to generate nice YARD docs for a given module 
path, replacing the default RDOC-style site from "puppet doc --modulepath 
..."? Could the YARD Template from Puppet 3.1 be used for this?

-- 
You received this message because you are subscribed to the Google Groups
"Puppet Users" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to puppet-users+unsubscribe@googlegroups.com.
To post to this group, send email to puppet-users@googlegroups.com.
Visit this group at http://groups.google.com/group/puppet-users?hl=en.
For more options, visit https://groups.google.com/groups/opt_out.

I know that Puppet 3.1 uses YARD to document the Ruby code (not manifests). 
The question is if the parser logic for RDOC templates can be used together 
with YARD:

* 
https://github.com/puppetlabs/puppet/blob/master/lib/puppet/util/rdoc/generators/puppet_generator.rb
* 
https://github.com/puppetlabs/puppet/blob/master/lib/puppet/util/rdoc/parser.rb

Sry for the confusion (and doubleposting).

Am Donnerstag, 11. April 2013 10:43:15 UTC+2 schrieb Sven
Sporer:
>
> Hi, Puppet 3.1 now uses YARD to generate its API documentation. Is anybody 
> aware of the possibility to generate nice YARD docs for a given module 
> path, replacing the default RDOC-style site from "puppet doc
--modulepath
> ..."? Could the YARD Template from Puppet 3.1 be used for this?
>
-- 
You received this message because you are subscribed to the Google Groups
"Puppet Users" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to puppet-users+unsubscribe@googlegroups.com.
To post to this group, send email to puppet-users@googlegroups.com.
Visit this group at http://groups.google.com/group/puppet-users?hl=en.
For more options, visit https://groups.google.com/groups/opt_out.

Hey,

I had the same question. I can tell you that just using YARD won''t
work,
you''ll only get warnings about undocumentable classes.

As far as I can understand, a Handler and Parser will have to be written 
for YARD if we want to use it to document Puppet code. Better even, `puppet 
doc` just needs to get fixed (which could then use YARD once a Handler and 
Parser have been written).

-- 
Daniele Sluijters

On Thursday, 11 April 2013 10:56:16 UTC+2, Sven Sporer
wrote:
>
> I know that Puppet 3.1 uses YARD to document the Ruby code (not 
> manifests). The question is if the parser logic for RDOC templates can be 
> used together with YARD:
>
> * 
>
https://github.com/puppetlabs/puppet/blob/master/lib/puppet/util/rdoc/generators/puppet_generator.rb
> * 
>
https://github.com/puppetlabs/puppet/blob/master/lib/puppet/util/rdoc/parser.rb
>
> Sry for the confusion (and doubleposting).
>
> Am Donnerstag, 11. April 2013 10:43:15 UTC+2 schrieb Sven Sporer:
>>
>> Hi, Puppet 3.1 now uses YARD to generate its API documentation. Is 
>> anybody aware of the possibility to generate nice YARD docs for a given
>> module path, replacing the default RDOC-style site from "puppet
doc
>> --modulepath ..."? Could the YARD Template from Puppet 3.1 be used
for this?
>>
>
-- 
You received this message because you are subscribed to the Google Groups
"Puppet Users" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to puppet-users+unsubscribe@googlegroups.com.
To post to this group, send email to puppet-users@googlegroups.com.
Visit this group at http://groups.google.com/group/puppet-users?hl=en.
For more options, visit https://groups.google.com/groups/opt_out.