Hi Carl, I also missed your e-mail. Thanks to Matt and James, I now can answer it :)
On 31/10/10 05:32, Carl Caum wrote: > What's the best way to add a new mode for the puppet doc output? I > would like to automatically generate our Confluence documentation > from our puppet code. It depends on what you are talking about. Puppet doc is currently used for two very different things: * producing html output from the documentation you embed into your own manifests (the so called rdoc mode) * producing reStructured output from the puppet documentation metadata embedded in the puppet ruby code. This is what forms the puppetlabs puppet documentation website. > I played with just taking the reStructured text > and converting it to something Confluence would understand, but > that's not exactly the "right" way to do it. Instead, I would just > like to add a mode and format it myself, but I can't figure out any > way to do that. Keep in mind I'm still very new to Ruby. Thanks in > advance. To fully answer your question, it all depends on what information you want to output (ie see above the distinction). If you were talking about your own manifest documentation, you need to create a new RDoc generator modeled from the puppet_generator.rb that can create confluence pages. Note that this isn't an easy task (have a look to the puppet_generator.rb to understand what I mean). If you were talking about generating the puppet reference documentation (ie types, providers, functions...) in confluence format, then you need to add a new format to the Puppet::Util::Reference type (you can see how pdf is created from the reStructured text variant). James knows better than me about this part, but I believe the internal documentation was all converted to markdown for 2.6, which might better fit your needs. Hope that helps, -- Brice Figureau My Blog: http://www.masterzen.fr/ -- You received this message because you are subscribed to the Google Groups "Puppet Developers" 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-dev?hl=en.
