From: Lyle Johnson <lyle@...>
Date: 2003-09-18T00:30:00+09:00
Subject: Re: Main page for RDoc

Brian Candler wrote:

> Running rdoc on itself:
>   $ cd rdoc-0.9.0
>   $ rdoc
> 
> gives me 'tokenstream.rb' as the first page displayed when I view
> index.html. Doing "rdoc --main rdoc/rdoc.rb" gives me that page instead. But
> how do I get the README file as the front page?
> 
> If I try "rdoc --main README" then I get:
> Generating HTML...
> Could not find main page README
> Could not find main page README
> Could not find main page README
> Could not find main page README
> 
> In fact, README does not appear under the 'Files' list in the generated HTML
> at all.

I think that by default, RDoc only processes the *.rb files it sees. So 
in your case, you're specifying that README should be the main page, but 
since it doesn't have a .rb extension it doesn't get added to the file 
list. Try:

     rdoc --main README README rdoc

and see what happens.