froderik froderik - 3 months ago 27
Ruby Question

Include local images in RDoc

I have created an image with a "visual" tool that I want to include on the front page of my rdoc documentation. The front page is defined in a *.rdoc . I have found it possible to include external images but how do I include local ones?

Update: a work around is to add html for the image without the double quotes:

<img src=../../images/overview.jpg>
if the image is in the images folder in the root directory. (Assuming generating rdoc to some folder in the same folder.) A proper
/>
ending does not work either. The
/
gets added to the url.

Answer
rdoc-image:relative/path/to/image.png

in *.rdoc is converted to

<img src="relative/path/to/image.png">

in *.html, which works for me.

Reference: