Creating RI documentation

Hi,

Is there a canonical tutorial on how to create and distribute documentation
for my project?  I can get all of the libraries and executables installed
just fine, but I can't get docs to work to save my life.

I want some way for users who install my project (Puppet) using either gems
or a tarball (or, eventually, native system packages) to be able to get
console-based documentation (and I don't mean by using lynx or whatever to
surf html docs).

As far as I understand it, I'm supposed to generate RI documentation and
then merge it into some site-wide repository, but I can't seem to find
documentation on how to do this in a distributable way (i.e., I want to
generate ri docs which go into my gem and tarballs and then get installed on
the client system).  I would at least settle for generating the html
documentation (which I have at least figured out how to do), but I don't
know where to put that so that my users know how to find it.  Yes, I know
that I can publish those docs online, but it seems that at least part of the
point here is to provide local documentation, right?

I've read through the chapter in Programming Ruby, but it mainly talks about
how to create inline documentation and how to install it locally.  While
that's somewhat useful, I really need to know how to distribute the
documentation along with my code.

I'd still love an rdoc2man for my executables, but I understand that I will
probably need to write that converter myself.  Are people really that
uninterested in distributing man pages for their executables?  I'm pretty
surprised.

-- 
This space intentionally has nothing but text explaining why this space
has nothing but text explaining that this space would otherwise have
been left blank, and would otherwise have been left blank.
---------------------------------------------------------------------
Luke Kanies | http://reductivelabs.com | http://madstop.com