Can I link my docs to docs from other gems?

's Avatar


28 Nov, 2014 12:38 PM

I have classes that inherit from classes from other gems. Let's say my classes inherit from the class "DataStruct" from a hypothetical gem "datastruct". My documentation now correctly displays that "DataStruct" is the parent of my classes, but the DataStruct text is not clickable. My question is: is it possible to specify to that it should include other gems in references like "{DataStruct}" so it'll create a link to DataStruct in the documentation for the "datastruct" gem?

My desired result is to have references to objects in other gems clickable in my documentation. Is there any way to achieve that?

  1. Support Staff 1 Posted by lsegal on 28 Nov, 2014 12:45 PM

    lsegal's Avatar

    Currently the best way to do this would be to manually create a link directly to the "datastruct" gem's page using Markdown (or whatever markup format you are using). There is unfortunately no built-in syntax to cross-link documentation between gems.

  2. Support Staff 2 Posted by nap on 29 Nov, 2014 04:25 PM

    nap's Avatar

    This is a really great idea though :).

  3. 3 Posted by Tomas Sandven on 08 Dec, 2014 06:54 PM

    Tomas Sandven's Avatar

    It would be really useful to be able to link to Ruby's standard library as well, like:


Reply to this discussion

Internal reply

Formatting help / Preview (switch to plain text) No formatting (switch to Markdown)

Attaching KB article:


Attached Files

You can attach files up to 10MB

If you don't have an account yet, we need to confirm you're human and not a machine trying to post spam.

Keyboard shortcuts


? Show this help
ESC Blurs the current field

Comment Form

r Focus the comment reply box
^ + ↩ Submit the comment

You can use Command ⌘ instead of Control ^ on Mac