Method: YARD::Server::LibraryVersion#load_yardoc_from_gem

Defined in:
lib/yard/server/library_version.rb

#load_yardoc_from_gem ⇒ Object (protected)

Called when a library of source type “gem” is to be prepared. In this case, the #yardoc_file needs to point to the correct location for the installed gem. The yardoc file is built if it has not been done.

Raises:

Since:

  • 0.6.0



226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/yard/server/library_version.rb', line 226

def load_yardoc_from_gem
  return if ready?
  ver = version ? "= #{version}" : ">= 0"

  @@chdir_mutex.synchronize do
    Thread.new do
      # Build gem docs on demand
      log.debug "Building gem docs for #{to_s(false)}"
      CLI::Gems.run(name, ver)
      log.debug "Done building gem docs for #{to_s(false)}"
    end
  end

  raise LibraryNotPreparedError
end