On Thu, Oct 18, 2012 at 10:06 PM, Nan Liu <[email protected]> wrote:

> Hi!
>
> The existing puppet manifests documentation generated via rdoc isn't
> very dry. I quite like docco generated documentation so I borrowed
> from rocco to create a puppet manifests documentation tool called
> pocco.
>

Awesome Nan! What's the usage for this? Is one to run rocco against a
manifest?


>
> 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?


>
>
> 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?


>
>
> WARNING: unless pymentize is installed, manifests are shipped to
> pygments.appspot.com for highlighting, so don't try this on anything
> sensitive.
>
> It's just an experiment, but feel free to provide feedback.
>

Would anyone be interested in seeing the Forge processing documentation
like this and displaying it on a module page? This tool is very manifest
centric so the challenge would be to compose module-wide documentation in a
meaningful way but this is the awesome-sauce.


>
> Thanks,
>
> Nan
>


-- 
Ryan Coleman | Modules & Forge @PuppetLabs
Want to get a hold of me?
  - @ryanycoleman on Twitter
  - ryancoleman in #puppet on Freenode
  - https://tungle.me/ryanycoleman to schedule a Skype meeting

-- 
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