From: James Britt <james.britt@...>
Date: 2009-02-20T11:34:56+09:00
Subject: Re: How does one generate a "main page" for rdoc documentation?

Igor Pirnovar wrote:
> Where did you get the syntax for your:
>   +---------------------------------+
>   | rdoc --main maindocpage rex.rb  |
>   +---------------------------------+
> 
> The only thing you need is run rdoc without any arguments (parameters) 
> in a directory where is your documented Ruby program; i.e.: cd into that 
> directory! This command (rdoc) will create the HTML documentation in the 
> "doc" directory in the same directory where you placed your "rex.rb" and 
> where you have executed rdoc. in other words, after execution of rdoc 
> look for "./doc/index.html". This is your main documentation page 
> including all dependent Ruby files your "rex.rb" may have.

Without telling rdoc what files to treat as "main", you may be surprised 
which file it picks if you have more than one.

-- 
James Britt

www.jamesbritt.com           - Playing with Better Toys
www.ruby-doc.org             - Ruby Help & Documentation
www.rubystuff.com            - The Ruby Store for Ruby Stuff