Is there a way to portably create a 'link:' ? about rdoc HOT 6 CLOSED

The directory layout of generated documentation changed between RDoc 1 and RDoc 3. Poking through the code I don't see an easy way to make the link: scheme portable between the two versions.

RDoc will link a plain file name, so:

Here is a reference to the file.txt

In README.rdoc will create a link to file.txt. It's not as pretty but it is a workaround

For forward compatibility I could add an rdoc: scheme that links to the correct place for use in friendly links in case the directory structure changes. For example:

{RDoc driver}[rdoc:RDoc::RDoc] would link to RDoc/RDoc.html
{README}[rdoc:README.txt] would link to README_txt.html

How does this sound?

from rdoc.

So would the plan be to add the rdoc: scheme to both RDoc 1 and RDoc 3? I think that would be a great solution. Do you have any idea how long it would take updates to RDoc 1 to propagate to the stdlib?

Regarding your workaround, RDoc 1.0.1 isn't creating a link for me using a plain file name. Am I on too old a version or does that only work with RDoc 3? Thanks for your quick response to this and other issues.

from rdoc.

It would not be added to RDoc 1. The 1.8.7 branch only accepts bug fixes for future patchlevels and there will be no 1.8.8 release to add the feature to. Unfortunately RDoc 1 (and Ruby 1.8) are officially dead.

The advantage of the rdoc: scheme is that it would create a correct link if the file structure changed in a future generator or incompatible version of RDoc.

I think you are right that the plain link doesn't work in RDoc 1… now that you mention it I seem to recall adding it.

from rdoc.

Darn, sounds like there isn't much that can be done for RDoc 1. Oh well, I guess you have to move forward at some point! Last question before I personally consider this issue closed - do you know when RDoc 3 is going to be a part of the 1.9 stdlib? Currently I have 1.9.2-p180 which looks like it comes with RDoc 2.5.8.

from rdoc.

The Ruby 1.9.3 branch currently contains RDoc 3.8 and I will be importing 3.9 today or tomorrow.

from rdoc.

I changed the scheme to rdoc-ref:

from rdoc.