#5415 [PATCH] Replaces relative rdoc links with hyperlinks to the Rails API documentation. - Ruby on Rails

Type	To find
responsible:me	tickets assigned to you
tagged:"@high"	tickets tagged @high
milestone:next	tickets in the upcoming milestone
state:invalid	tickets with the state invalid
created:"last week"	tickets created last week
sort:number, importance, updated	tickets sorted by #, importance or updated
Combine keywords for powerful searching.
Use advanced searching »

This project is archived and is in readonly mode.

#5415 ✓committed

[PATCH] Replaces relative rdoc links with hyperlinks to the Rails API documentation.

Reported by joost baaij | August 19th, 2010 @ 09:46 PM

Fixes the currently broken links in the top level README.
Also makes github render these files nicely as rdoc instead of plain text.
Has the added benefit of referring to a known source on the web in the documentation, instead of generated html files which are likely not present on developer's machines anyway.

This commit does not touch other relative rdoc links, e.g. those in the app generator or inline comments.

rdoc-patch.diff 12.5 KB

Comments and changes to this ticket

Xavier Noria August 24th, 2010 @ 07:29 AM
- Assigned user set to “Xavier Noria”
- Importance changed from “” to “Medium”
Good!

Could these links be relative? The API may also be generated to be read offline, for example with the doc:rails rake task.
You flagged this item as spam.
joost baaij August 24th, 2010 @ 10:11 AM
Making the links relative would work for local files, but would break the generated RDoc that you see on Github again.

As it stands I can't seem to marry both worlds at this time. A tweak to Github's markup library (http://github.com/github/markup/blob/master/lib/github/markup/rdoc.rb) might be needed. I will investigate that and update this ticket.
Xavier Noria August 24th, 2010 @ 10:26 AM
Excellent.

If there's a conflict the API should win (the current relative links need to be revised anyway because they are not valid).
You flagged this item as spam.
joost baaij August 24th, 2010 @ 11:26 AM
I am going to split this problem in two. First fix the broken relative links in the readmes, then make sure github sees them as valid rdoc.

For the first half, this patch fixes the broken links. It applies to both master and 3-0-stable.
- rdoc-relative-links.diff 3.4 KB
You flagged this item as spam.
joost baaij August 24th, 2010 @ 12:04 PM
For the second half of this problem, a fix has already been pushed to the github-markup repo.

http://github.com/github/markup/commit/f65c5fdad47612d4218b6e37dbfe...

But it hasn't made it to the gem or GitHub production yet. I will ask them to push out a new version so our README.rdoc render properly.
Repository August 24th, 2010 @ 03:22 PM
- State changed from “new” to “committed”
(from [a32f46d0ceebb441f8aea935699aa27b401fe8cb]) fix broken relative links [#5415 state:committed]

Signed-off-by: Xavier Noria fxn@hashref.com
http://github.com/rails/rails/commit/a32f46d0ceebb441f8aea935699aa2...
Repository August 24th, 2010 @ 03:22 PM
(from [20333be581a7fb7584e1689b22b1ed5637c73ffa]) fix broken relative links [#5415 state:committed]

Signed-off-by: Xavier Noria fxn@hashref.com
http://github.com/rails/rails/commit/20333be581a7fb7584e1689b22b1ed...