RDoc 2.0.0

drbrain | Fri, 11 Apr 2008 01:21:00 GMT

Posted in ,

rdoc version 2.0.0 has been released!

http://rubyforge.org/projects/rdoc

http://rdoc.rubyforge.org/rdoc

RDoc is an application that produces documentation for one or more Ruby source files. RDoc includes the `rdoc` and `ri` tools for generating and displaying online documentation.

At this point in time, RDoc 2.x is a work in progress and may incur further API changes beyond what has been made to the RDoc 1.0.1. Command-line tools are largely unaffected, but internal APIs may shift rapidly.

Changes:

  • 3 Major Enhancements:
    • Renamespaced everything RDoc under the RDoc module.
    • New `ri` implementation.
      • Reads from a cache in ~/.ri/ for enhanced speed.
      • RubyGems aware, only searches latest gem versions.
    • Now up to over 100 tests and 200 assertions.
  • 4 Minor Enhancements:
    • Switched to an ERb-based TemplatePage, see RDoc::TemplatePage.
    • Class/module ri now displays attribute and constant comments.
    • Cross-references can be disabled with a leading \.
    • Relaxed parsing for some RDoc inline markup.

Bugs:

If you found a bug, please report it at the RDoc project's tracker on RubyForge: http://rubyforge.org/tracker/?group_id=627

Synopsis:

  gem 'rdoc'
  require 'rdoc/rdoc'
  # ... see RDoc
comments

Comments RSS FEED

speed, yes, pretty much welcome speed increase to ri.

pedro mg said 35 minutes later

Could you disable rdoc.sourceforge.net and make it redirect to rdoc.rubyforge.org? It’s really confusing to have multiple websites where one is outdated. Last time I looked for information on RDoc, I searched Google, and rdoc.sourceforge.net (with the outdated info) was the first hit. Only after reading several random blog posts did I find out that rdoc.sourceforge.net is abandoned.

Hongli Lai said about 6 hours later

Just my 2 cents: why is searching only in the latest gems a good idea? I know that the Ruby and Rails world is mostly cutting edge, but some projects rely on previous gem versions that are installed next to newer versions. One example is ActiveRecord for Rails 1.2.6 vs. ActiveRecord for Rails 2.0.2.

Or is it something that I’m missing?

Andrei Maxim said 3 days later

RDoc sometimes has problems merging documentation from multiple sources, so this is a workaround until I can solve that problem deeper in the codebase. Even if I fix this bug, most of the documentation for the gem will be the same, and showing nearly identical documentation twice isn’t very useful.

Also, most of the time you only care about the latest documentation, so by only traversing the latest directories there’s less for ri to do. If you want to review an old version, `gem server` will give you old documentation to browse.

Eric Hodel said 3 days later

Comments are disabled