The combination of courtyard documents for several gems

I use YARD to create documents for several projects I'm working on. Firstly, I jointly develop a gem that hosts a lot of redundant and shared resources that will be used by other projects.

What I would like is links to the first project on classes or methods in gem so that they appear in documents for the main project. for example

Gemstone

class Widget
  # Spins the widget of course.
  def spin
  end
end

Project

class SpecialWidget
  # Jump and {#spin}.
  def dance
  end
end

I would like the documents for SpecialWidget to generate the actual reference to the Widget # spin method.

Can this be done?

+4
source share

Source: https://habr.com/ru/post/1525518/


All Articles