On Fri, Oct 19, 2012 at 10:11 AM, Ryan Coleman <r...@puppetlabs.com> wrote:
> Awesome Nan! What's the usage for this? Is one to run rocco against a
> manifest?
Run pocco against a modules directory:
pocco /etc/puppet/modules/<modulename>
I'm guessing this is making a bit much in assumptions. Might need to
enable runs against a manifests.
And to explain the format a bit:
# markdown
class or define <name> (
$var = default, #: var comment (note it's #:)
) {
...
#normal comments
...
}
pocco will generate
### class/define <name>
markdown
### variables
* [var]: var comment (default)
### usage
import matching tests/*.pp file
normal comments
>> Here's a module that will install the tool:
>> https://github.com/nanliu/puppet-pocco
>
> Sweet! Would you please throw this up on the Forge?
Yes, I'll cut a version and upload it.
>> Here's a sample documentation generated from the manifest in the module:
>> http://nanliu.github.com/puppet-pocco/
>
>
> This is very slick. Is there an option to get the documentation back without
> the manifest code if that's desired?
No, not at the moment. The comments with the code would lose context,
but maybe a header only documentation makes sense.
Nan
--
You received this message because you are subscribed to the Google Groups
"Puppet Users" group.
To post to this group, send email to puppet-users@googlegroups.com.
To unsubscribe from this group, send email to
puppet-users+unsubscr...@googlegroups.com.
For more options, visit this group at
http://groups.google.com/group/puppet-users?hl=en.
