Hi Which version of puppet are you using?
On Wed, 2009-02-18 at 14:41 -0800, chakkerz wrote: > Hello there > > I'm trying to get my modules to a deployment stage, and for that i > would love to have documentation in place. And it'd be awesome to have > the stuff in a way so puppetdoc can parse and output stuff. > > I gather i still have to tell it what it does etc, but I'm not getting > anything back, no error no nothing. > > Has anyone got a module which puppetdoc parses and is generally > informative about? I figured it should probably look like puppetca but > the whole: > # = Name > # some text > > isn't doing anything. > > Any ideas what i'm missing? > > Also, i might be running the command wrong. So for example, i execute > `puppetdoc /etc/puppet/modules/ntp_conf/manifest/init.pp` or > `puppetdoc --all /etc/puppet/manifest/site.pp` ... neither responds > with anything > If you are using puppet >= 0.24.7, see puppetdoc documentation (puppetdoc --help or http://www.reductivelabs.com/trac/puppet/wiki/PuppetManifestDocumentation). Puppetdoc (still >= 0.24.7) can also output directly documentation to the console, with the following syntax puppetdoc /path/to/my/puppet/file.pp If it doesn't print anything, try to run with --debug and --trace. You should also be aware that the documentation must be "attached" to the object, that is the comment must not be separated by blank likes: # this works class this_works ... # this doesn't work because of the next blank line class this_doesnt_work Also, if you are gathering module documentation (and not documentation for specific classes), put the module documentation in the /path/to/module/README file. Puppetdoc (in rdoc mode) will find it as use it as the module documentation. Hope that helps -- Brice Figureau My Blog: http://www.masterzen.fr/ --~--~---------~--~----~------------~-------~--~----~ 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 -~----------~----~----~----~------~----~------~--~---
