[Pkg-ruby-extras-maintainers] Documentation generation

[Esteban Manchado Velázquez]

Hi all,

    Now that we have some beginning of a naming convention, I would like to
solve the documentation generation issue.

    I've looked at Lucas' package, and he simply uses "rake doc". Yesterday,
hacking around with the CDBS class, I added documentation package support, and
I also implemented it with a rake call.

    But, I don't think generating documentation from the CDBS class, via rake,
is a good idea, because:

1) We're then relying on upstream having a Rakefile with a special task to
generate the documentation we want.

2) We will be using, then, upstream documentation generation options, instead
of the ones we decide to use.

So, after a little thought, I think we should better call rdoc directly, with
the options we decide (I think Lucas had a proposal in some thread). The
options, of course, will be overridable via make variables or something
similar.

    Another problem is that I don't know in what directories RI searchs for
the documentation. Anyone knows? At least for Ruby core documentation, it's
put in version-dependent directories. If we can't use a version-independent
one, I think we can just generate RI only for the default version, what do you
think?

    And finally, how is the user supposed to access rdoc documentation?
Opening /usr/share/doc/libfoo-ruby-doc/rdoc/index.html in a web browser? Are
we going to somehow register rdoc documentation in dhelp/doc-base? I think we
should...

    Regards,

-- 
Esteban Manchado Velázquez <zoso at debian.org>
EuropeSwPatentFree - http://EuropeSwPatentFree.hispalinux.es
Help spread it through the Net in signatures, webpages, whatever!
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 189 bytes
Desc: Digital signature
Url : http://lists.alioth.debian.org/pipermail/pkg-ruby-extras-maintainers/attachments/20051209/0c1441df/attachment.pgp