RDoc's TemplatePage Removed from Ruby

[Eric Hodel]

If you've got a custom RDoc template, it won't work in the next
release of Ruby 1.9.

You can find details on how to convert from an old TemplatePage
template to the new ERB-based TemplatePage wrapper here:

http://blog.segment7.net/articles/2008/01/07/rdocs-templatepage-removed-from-ruby

This should make it much easier to build templates for RDoc output
than it has been in the past.

I plan on making some further changes to the organization of the RDoc
generation code, including documentation of what gets rendered when
and what values are provided to the template. I'll also be providing
additional information to the templates which should enable more-
flexible page generation.

If you are a template author, I'd like to know what additional data
you'd want in a template so I can include it.

At some point in the future there will be a release of my RDoc work-in-
progress. Until then, you'll need to check it out from ruby trunk.

 

[Suraj Kurapati]

I plan on making some further changes to the organization of the RDoc
generation code, including documentation of what gets rendered when
and what values are provided to the template.

One piece of information that's lacking from the current RDoc output is
the name of the file in which a method is defined.

We have several odd cases in Ruby where the name of a class does not
reflect the name of the file in which it is defined: for example, Mutex
and Queue are provided by the 'thread' file.

Also, there may be cases in the universe of Ruby libraries where a
method is defined in a file different from the main definition of a
class; in such cases, providing the name of the file in which a class is
defined is insufficient.

Often times, I find a cool method when browsing the output of `ri` but I
cannot figure out what file I need to require() in order to use the
method. For the sake of documentation, I request that this information
is provided along with every method.

Thanks for your consideration.

 

[Eric Hodel]

One piece of information that's lacking from the current RDoc output
is
the name of the file in which a method is defined.

Working in the template space is familiarizing me with how the RDoc
data is structured, so I should soon find a solution for this.