Method: YARD::Server::Adapter#initialize

Defined in:

lib/yard/server/adapter.rb

#initialize(libs, opts = {}, server_opts = {}) ⇒ Adapter

Creates a new adapter object

Parameters:

• libs (Hash{String=>Array<LibraryVersion>}) —

  a list of libraries, see #libraries for formulating this list.

• opts (Hash) (defaults to: {}) —

  extra options to pass to the adapter

Options Hash (opts):

• :router (Class) — default: Router —

  the router class to initialize as the adapter’s router.

• :caching (Boolean) — default: false —

  whether or not caching is enabled

• :single_library (Boolean) — default: false —

  whether to server documentation for a single or multiple libraries (changes URL structure)

Since:

• 0.6.0

# File 'lib/yard/server/adapter.rb', line 71

def initialize(libs, opts = {}, server_opts = {})
  self.class.setup
  self.libraries = libs
  self.options = opts
  self.server_options = server_opts
  self.document_root = server_options[:DocumentRoot]
  self.router = (options[:router] || Router).new(self)
  options[:adapter] = self
  log.debug "Serving libraries using #{self.class}: #{libraries.keys.join(', ')}"
  log.debug "Caching on" if options[:caching]
  log.debug "Document root: #{document_root}" if document_root
end