Class/Module Index [+]

Quicksearch

YARD::CLI::Server

A local documentation server @since 0.6.0

Attributes

adapter[RW]

@return [Adapter] the adapter to use for loading the web server

libraries[RW]

@return [Hash] a list of library names and yardoc files to serve

options[RW]

@return [Hash] a list of options to pass to the doc server

scripts[RW]

@return [Array<String>] a list of scripts to load @since 0.6.2

server_options[RW]

@return [Hash] a list of options to pass to the web server

template_paths[RW]

@return [Array<String>] a list of template paths to register @since 0.6.2

Public Class Methods

new() click to toggle source

Creates a new instance of the Server command line utility

# 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

Public Instance Methods

description() click to toggle source
# File lib/yard/cli/server.rb, line 39
def description
  "Runs a local documentation server"
end
run(*args) click to toggle source
# 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

[Validate]

Generated with the Darkfish Rdoc Generator 2.