This project is archived and is in readonly mode.
[PATCH] Replaces relative rdoc links with hyperlinks to the Rails API documentation.
-
Xavier Noria
- 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.
-
joost baaij
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
Excellent.
If there's a conflict the API should win (the current relative links need to be revised anyway because they are not valid).
-
joost baaij
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.
-
joost baaij
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
- State changed from new to committed
(from [a32f46d0ceebb441f8aea935699aa27b401fe8cb]) fix broken relative links [#5415 [PATCH] Replaces relative rdoc links with hyperlinks to the Rails API documen... state:committed]
Signed-off-by: Xavier Noria fxn@hashref.com
http://github.com/rails/rails/commit/a32f46d0ceebb441f8aea935699aa2... -
Repository
(from [20333be581a7fb7584e1689b22b1ed5637c73ffa]) fix broken relative links [#5415 [PATCH] Replaces relative rdoc links with hyperlinks to the Rails API documen... state:committed]
Signed-off-by: Xavier Noria fxn@hashref.com
http://github.com/rails/rails/commit/20333be581a7fb7584e1689b22b1ed...
