Images in generated rdoc?


#1

Hi.

I’m trying to incorporate some images in rdoc generated html. This is a
rails project and I’ve cloned the doc:app task. In the README_FOR_APP
file I
have a reference to an image using the link tag, like so:

link:schema.png

This generates a relative link like this:

This somewhat makes sense because the rake task sets the rdoc_dir to
‘doc/app’. But the image is not there – in order for it to get there it
must be moved there.

Of course I can move it, but it could be that I’m missing something
obvious
here.

Seems like, if you specify an output directory AND a local href (via
‘link’), that it should move the assets to the output directory.

Any suggestions?

Thanks,

-Kelly


#2

Kelly F. wrote:

This somewhat makes sense because the rake task sets the rdoc_dir to
‘doc/app’. But the image is not there – in order for it to get there it
must be moved there.

Of course I can move it, but it could be that I’m missing something obvious
here.

dunno if this helps but you can use a path in the link:

{README}[link:…/api/files/README.html]

(The {} specifies what the visible text of the link will be.)