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

I

Iwan van der Kleyn

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
 
S

Stefan Lang

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...]
 

Ask a Question

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

You'll need to choose a username for the site, which only take a couple of moments. After that, you can post your question and our members will help you out.

Ask a Question

Members online

No members online now.

Forum statistics

Threads
473,744
Messages
2,569,482
Members
44,901
Latest member
Noble71S45

Latest Threads

Top