So your probably looking for 'puppet describe'.  Just make sure you have the 
type/provider's lib directory in your RUBYLIB path and run the command.  So if 
the custom type/provider is already installed it should just work.  Here is an 
example of one I was hacking on several months back.

RUBYLIB=$HOME/src/modules/cloud_vm/lib puppet describe -s cloud_vm

cloud_vm
========
Doing stuff


Parameters
----------
   access_key, api_key, ensure, flavor, id, image, name, region, user_data

Providers
---------
   ec2


--
Cody Herriges
Professional Service Engineer - Puppet Labs
pgp key: 0x5DB77142 @ pgp.mit.edu





On Feb 1, 2012, at 3:18 PM, vertigo wrote:

> Hi All.
> 
> We have written an extensive custom type (with provider) for an
> internal product that I would like to document using the @doc class
> instance variable and calls to desc in the type.
> 
> For the life of me, I cannot work out (or find an example) of how to
> extract said documentation. Do you use puppet doc? rdoc? another tool?
> I have seen nearly all documentation detailing custom types, and they
> all tell you to use the @doc and desc, but don't tell you how to then
> utilise it.
> 
> Cheers!
> 
> -- 
> You received this message because you are subscribed to the Google Groups 
> "Puppet Users" group.
> To post to this group, send email to [email protected].
> To unsubscribe from this group, send email to 
> [email protected].
> For more options, visit this group at 
> http://groups.google.com/group/puppet-users?hl=en.
> 

-- 
You received this message because you are subscribed to the Google Groups 
"Puppet Users" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to 
[email protected].
For more options, visit this group at 
http://groups.google.com/group/puppet-users?hl=en.

Reply via email to