text: 0 replies on
  1 page.
  RDoc produces HTML and command-line documentation for Ruby projects. RDoc
  includes the +rdoc+ and +ri+ tools for generating and displaying documentation
  from the command-line.
  RDoc 4.0 includes several new features and several breaking changes. The
  changes should not affect users of rdoc or ri.
  rdoc
  ri
  Notable feature additions are markdown support and an WEBrick servlet that can
  serve HTML from an ri store. (This means that RubyGems 2.0+ no longer needs
  to build HTML documentation when installing gems.)
  Changes since RDoc 3.12.1:
  Breaking changes
  RDoc::RI::Store is now RDoc::Store so ri data generated by RDoc 4 cannot
  be read by earlier versions of RDoc. RDoc::RI::Store exists as an alias
  of RDoc::Store so ri data from older versions can still be read.
  RDoc::RI::Store will be removed in RDoc 5.
  Tests that create RDoc::CodeObjects on the fly without wiring them into
  the documentation tree (did not use add_class, add_method, etc.) must be
  updated to use these methods. The documentation tree automatically
  attaches them to the store instance which allows lookups to work
  correctly. Additionally, a new method RDoc::Store#add_file must be used
  instead of RDoc::TopLevel.new. The latter will not be attached to the
  documentation tree.
  Major enhancements
  ri can now show pages (README, etc.)
  ri rdoc:README
  Will show the README for the latest version of RDoc. You can specify
  exact gem versions such as "rdoc-4.0:README" or view pages from the
  standard library documentation with "ruby:README".
  RDoc 3 did not save pages in ri data so you will need to regenerate
  documentation from your gems to use this feature.
  Removed global state from RDoc. RDoc::Store holds the documentation tree
  and connects the driver to the parsers and generator. This also allows
  documentation parsing and generation for multiple instances, but the rdoc
  command-line tool does not support this.
  Due to this change RDoc::RDoc.current and RDoc::RDoc.reset no longer
  exist.
  Minor enhancements
  Added --page-dir option to give pretty names for a FAQ, guides, or other
  documentation you write that is not stored in the project root. For
  example, with the following layout:
  README.txt
  guides/syntax.txt
  guides/conversion.txt
  Running rdoc --page-dir guides will make the files in "guides" appear to
  be at the top level of the project. This means they will appear to exist
  at the top level in HTML output and you can access them with
  ri your\_gem:syntax and ri your\_gem:conversion.
  rdoc --page-dir guides
  ri your\_gem:syntax
  ri your\_gem:conversion
  Bug fixes
  text{link}[]
  ?z
  def self.&() end
  Changes since RDoc 4.0.0.rc.2:
  Read: rdoc 4.0.0