Class: YARD::CLI::Server

Inherits:
Command show all
Defined in:
lib/yard/cli/server.rb

Overview

A local documentation server

Since:

  • 0.6.0

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeServer

Creates a new instance of the Server command line utility

Since:

  • 0.6.0


27
28
29
30
31
32
33
34
35
36
37
# File 'lib/yard/cli/server.rb', line 27

def initialize
  super
  self.scripts = []
  self.template_paths = []
  self.libraries = {}
  self.options = SymbolHash.new(false).update(
    :single_library => true,
    :caching => false
  )
  self.server_options = {:Port => 8808}
end

Instance Attribute Details

#adapterAdapter

Returns the adapter to use for loading the web server

Returns:

  • (Adapter)

    the adapter to use for loading the web server

Since:

  • 0.6.0


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

def adapter
  @adapter
end

#librariesHash

Returns a list of library names and yardoc files to serve

Returns:

  • (Hash)

    a list of library names and yardoc files to serve

Since:

  • 0.6.0


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

def libraries
  @libraries
end

#optionsHash

Returns a list of options to pass to the doc server

Returns:

  • (Hash)

    a list of options to pass to the doc server

Since:

  • 0.6.0


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

def options
  @options
end

#scriptsArray<String>

Returns a list of scripts to load

Returns:

Since:

  • 0.6.2


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

def scripts
  @scripts
end

#server_optionsHash

Returns a list of options to pass to the web server

Returns:

  • (Hash)

    a list of options to pass to the web server

Since:

  • 0.6.0


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

def server_options
  @server_options
end

#template_pathsArray<String>

Returns a list of template paths to register

Returns:

  • (Array<String>)

    a list of template paths to register

Since:

  • 0.6.2


24
25
26
# File 'lib/yard/cli/server.rb', line 24

def template_paths
  @template_paths
end

Instance Method Details

#descriptionObject

Since:

  • 0.6.0


39
40
41
# File 'lib/yard/cli/server.rb', line 39

def description
  "Runs a local documentation server"
end

#run(*args) ⇒ Object

Since:

  • 0.6.0


43
44
45
46
47
48
49
50
# File 'lib/yard/cli/server.rb', line 43

def run(*args)
  optparse(*args)

  select_adapter.setup
  load_scripts
  load_template_paths
  adapter.new(libraries, options, server_options).start
end