This post originated from an RSS feed registered with Ruby Buzz by Eric Hodel. Original Post: rdoc, rdoc_chm, rdoc_html_templates 2.3.0 Released Feed Title: Segment7 Feed URL: http://blog.segment7.net/articles.rss Feed Description: Posts about and around Ruby, MetaRuby, ruby2c, ZenTest and work at The Robot Co-op. Latest Ruby Buzz Posts Latest Ruby Buzz Posts by Eric Hodel Latest Posts From Segment7

RDoc version 2.3.0 has been released!

This release of RDoc brings some big changes. Most notably Michael Granger’s Darkfish generator has become the default output format for RDoc! Michael put a ton of great work into this, and it looks quite lovely. Check out the RDoc documentation for a sample.

rdoc_chm and rdoc_html_templates have been split off from RDoc and released separately as unmaintained software. I don’t plan to make any future changes or updates to rdoc_html_templates (which are for the old HTML generator) ever, but somebody may be interested in taking over maintainership of the rdoc_chm generator.

rdoc will automatically detect rdoc_html_templates and rdoc_chm, so you only need to install them to make them usable via command-line options.

Release notes

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 RDoc 1.0.1. Command-line tools are largely unaffected, but internal APIs may shift rapidly.

See the RDoc documentation for a description of RDoc’s markup and basic use.

Changes:

• 3 Major Enhancements
  • Michael Granger’s Darkfish generator is now the default for HTML output
  • Various rdoc generation speedups by Hongli Lai. Patches #22555, #22556, #22557, #22562, #22565.
  • rdoc/discover.rb files are loaded automatically from installed gems
• 8 Minor Enhancements
  • Added a space after the commas in ri class method lists. RubyForge enhancement #22182.
  • Improved ri—interactive
  • Generators can now override generated file locations
  • Moved unmaintained CHM generator to it’s own package
  • Moved unmaintained extra HTML templates to their own package
  • Removed experimental texinfo generator
  • Converted to minitest
  • Known classes and modules list outputs once per line now for grep
• 11 Bug Fixes
  • Fix missing superclass in ri output
  • Fix an RDoc crash when told to parse an empty file
  • Ignore nonexistent files instead of crashing
  • .txt and .rdoc files are always considered text. Patch #22897 by Aaron Patterson.
  • When merging ri data with a nonexistant directory, RDoc no longer crashes
  • Fix visibility of methods in XML output. Issue by Yehuda Katz.
  • Fixed relative link generation
  • Fix crash, RDoc now ignores comments above local variable assignments in modules
  • RDoc now only accepts adjacent comments for rb_define_module and rb_define_class
  • C file RDoc is no longer included in token stream
  • Scan all gem paths to match gem name for ri output