adding files to rdoc

Discussion in 'Ruby' started by Roger Pack, Jul 25, 2008.

  1. Roger Pack

    Roger Pack Guest

    Wasn't able to find an answer to this one trivially...

    So gemspecs have the 'rdoc_extra_files' option to be able to specify
    README as their main file [index.html].
    How might this be accomplished on the command line? rdoc --help doesn't
    mention extra files.
    rdoc --main README results in

    Generating HTML...
    Could not find main page README

    Thanks!
    -R
    --
    Posted via http://www.ruby-forum.com/.
     
    Roger Pack, Jul 25, 2008
    #1
    1. Advertising

  2. Roger Pack

    Eric Hodel Guest

    On Jul 24, 2008, at 22:56 PM, Roger Pack wrote:
    > Wasn't able to find an answer to this one trivially...
    >
    > So gemspecs have the 'rdoc_extra_files' option to be able to specify
    > README as their main file [index.html].
    > How might this be accomplished on the command line? rdoc --help
    > doesn't
    > mention extra files.
    > rdoc --main README results in
    >
    > Generating HTML...
    > Could not find main page README


    rdoc --main README README

    should do it, you also have to put the file in the files list.
     
    Eric Hodel, Jul 25, 2008
    #2
    1. Advertising

  3. Roger Pack

    Roger Pack Guest

    Eric Hodel wrote:
    > On Jul 24, 2008, at 22:56 PM, Roger Pack wrote:
    >> Could not find main page README

    > rdoc --main README README
    >
    > should do it, you also have to put the file in the files list.


    Thank you!
    rdoc --main README . README
    indeed does the trick.
    -R
    --
    Posted via http://www.ruby-forum.com/.
     
    Roger Pack, Jul 25, 2008
    #3
    1. Advertising

Want to reply to this thread or ask your own question?

It takes just 2 minutes to sign up (and it's free!). Just click the sign up button to choose a username and then you can ask your own questions on the forum.
Similar Threads
  1. Andreas Schwarz
    Replies:
    6
    Views:
    280
    Randy W. Sims
    Jan 1, 2004
  2. Brian Schröder
    Replies:
    5
    Views:
    161
    Dave Thomas
    Sep 18, 2004
  3. Daniel Berger
    Replies:
    1
    Views:
    157
    Dave Thomas
    Nov 2, 2004
  4. Iwan van der Kleyn

    rdoc: how to add readme.rdoc as index.html?

    Iwan van der Kleyn, Apr 26, 2005, in forum: Ruby
    Replies:
    1
    Views:
    262
    Stefan Lang
    Apr 26, 2005
  5. Paul Van Delst

    How to use rdoc parsers outside of rdoc?

    Paul Van Delst, Jul 27, 2006, in forum: Ruby
    Replies:
    0
    Views:
    120
    Paul Van Delst
    Jul 27, 2006
Loading...

Share This Page