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

Discussion in 'Ruby' started by Iwan van der Kleyn, Apr 26, 2005.

  1. Hi there,

    I'm finishing the documentation for a package I've written. I've written
    a general introduction in a README.rdoc file. I would like to set this
    file as the content of the index.html file when generating the
    documentation with Rdoc. Anyone an idea how to do this?

    Regards,

    Iwan
    Iwan van der Kleyn, Apr 26, 2005
    #1
    1. Advertising

  2. Iwan van der Kleyn

    Stefan Lang Guest

    On Tuesday 26 April 2005 14:19, Iwan van der Kleyn wrote:
    > Hi there,
    >
    > I'm finishing the documentation for a package I've written. I've written
    > a general introduction in a README.rdoc file. I would like to set this
    > file as the content of the index.html file when generating the
    > documentation with Rdoc. Anyone an idea how to do this?
    >
    > Regards,
    >
    > Iwan


    You can specify this with the --main option:
    % rdoc --main README.rdoc README.rdoc [other files/directories...]
    Stefan Lang, Apr 26, 2005
    #2
    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. karthikeyavenkat
    Replies:
    2
    Views:
    561
    Bryce
    Mar 17, 2005
  2. Sameen
    Replies:
    2
    Views:
    424
    Victor Bazarov
    Aug 29, 2005
  3. Une bévue

    draft HTML version of README.EXT

    Une bévue, Aug 17, 2006, in forum: Ruby
    Replies:
    3
    Views:
    110
    Une bévue
    Aug 27, 2006
  4. Jesper Rønn-Jensen
    Replies:
    4
    Views:
    127
    Joel VanderWerf
    Feb 22, 2008
  5. Tomasz Chmielewski

    sorting index-15, index-9, index-110 "the human way"?

    Tomasz Chmielewski, Mar 4, 2008, in forum: Perl Misc
    Replies:
    4
    Views:
    267
    Tomasz Chmielewski
    Mar 4, 2008
Loading...

Share This Page