Velocity Reviews - Computer Hardware Reviews

Velocity Reviews > Newsgroups > Programming > Ruby > Main page for RDoc

Reply
Thread Tools

Main page for RDoc

 
 
Brian Candler
Guest
Posts: n/a
 
      08-15-2003
OK, I'm probably being stupid here, but I'd appreciate being put right.

I've just started playing with rdoc, and have installed rdoc-0.9.0 under
ruby-1.8.0

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.

And yet, rdoc's own documentation at
http://rdoc.sourceforge.net/doc/index.html
manages to make the README the front page.

So what am I doing wrong..? It would certainly be useful if rdoc's
documentation included the command to run to generate rdoc's docs

Cheers,

Brian.

 
Reply With Quote
 
 
 
Reply

Thread Tools

Posting Rules
You may not post new threads
You may not post replies
You may not post attachments
You may not edit your posts

BB code is On
Smilies are On
[IMG] code is On
HTML code is Off
Trackbacks are On
Pingbacks are On
Refbacks are Off


Similar Threads
Thread Thread Starter Forum Replies Last Post
RDoc: How to link to a method description from other rdoc page? Iñaki Baz Castillo Ruby 3 07-28-2009 09:03 PM
How does one generate a "main page" for rdoc documentation? Kenneth McDonald Ruby 20 02-25-2009 05:37 PM
RDoc question: How do I make a link from the README file to aspecific RDOC Page Jesper Rønn-Jensen Ruby 4 02-22-2008 10:58 PM
gem & rdoc: How to avoid "Could not find main page name" warningwhen using gems? Thomas Ruby 1 08-18-2005 08:44 PM



Advertisments