Class: YARD::CLI::Server

Inherits:

Command

• Object
• Command
• YARD::CLI::Server

show all

Defined in:

lib/yard/cli/server.rb

Overview

Instance Attribute Summary (collapse)

• - (Adapter) adapter

  The adapter to use for loading the web server.

• - (Hash) libraries

  A list of library names and yardoc files to serve.

• - (Hash) options

  A list of options to pass to the doc server.

• - (Hash) server_options

  A list of options to pass to the web server.

Instance Method Summary (collapse)

• - (Object) description
• - (Object) run(*args)

Methods inherited from Command

#common_options, #parse_options, run

16
17
18

# File 'lib/yard/cli/server.rb', line 16

def adapter
  @adapter
end

13
14
15

# File 'lib/yard/cli/server.rb', line 13

def libraries
  @libraries
end

7
8
9

# File 'lib/yard/cli/server.rb', line 7

def options
  @options
end

10
11
12

# File 'lib/yard/cli/server.rb', line 10

def server_options
  @server_options
end

18
19
20

# File 'lib/yard/cli/server.rb', line 18

def description
  "Runs a local documentation server"
end

22
23
24
25
26
27
28
29
30
31
32
33

# File 'lib/yard/cli/server.rb', line 22

def run(*args)
  self.libraries = {}
  self.options = SymbolHash.new(false).update(
    :single_library => true,
    :caching => false
  )
  self.server_options = {:Port => 8808}
  optparse(*args)
  
  select_adapter
  adapter.new(libraries, options, server_options).start
end