I'm being a good boy and using the puppetdoc tool to document my
classes, however I'm hitting a minor annoyance.

The top level documentation for a module (let's call it "example) is
pulled from example/README (not example/manifests/init.pp), okay I can
cope with that.

The documentation for the class in example/manifests/init.pp ends up
as example::example (hmm, interesting, I wonder what would happen if I
had example/manifests/example.pp).  However if I try and refer to this
from README I can only get links to the toplevel example doc (i.e.the
README).

I've tried lots of combinations, I was expecting to use something like
this in README:
# Example module - see example::example for default usage
# If you just want the client use example::client

however whilst "example::client" is a hyperlink to classes/example/
install.html, the first line is converted into two separate
hyperlinks, both to classes/example.html.

This is using puppet 2.6.4-0.5-el5 and ruby-rdoc 1.8.5-5.el5_4.8 on
RHEL 5.

Thanks,

Adrian

-- 
You received this message because you are subscribed to the Google Groups 
"Puppet Users" group.
To post to this group, send email to puppet-us...@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.

Reply via email to