Class: YARD::CLI::Server
Overview
A local documentation server
Instance Attribute Summary collapse
-
#adapter ⇒ YARD::Server::Adapter
The adapter to use for loading the web server.
-
#libraries ⇒ Hash
A list of library names and yardoc files to serve.
-
#options ⇒ Hash
A list of options to pass to the doc server.
-
#scripts ⇒ Array<String>
A list of scripts to load.
-
#server_options ⇒ Hash
A list of options to pass to the web server.
-
#template_paths ⇒ Array<String>
A list of template paths to register.
Instance Method Summary collapse
- #description ⇒ Object
-
#initialize ⇒ Server
constructor
Creates a new instance of the Server command line utility.
- #run(*args) ⇒ Object
Constructor Details
#initialize ⇒ Server
Creates a new instance of the Server command line utility
28 29 30 31 32 33 34 35 36 37 38 |
# File 'lib/yard/cli/server.rb', line 28 def initialize super self.scripts = [] self.template_paths = [] self.libraries = {} self. = SymbolHash.new(false).update( :single_library => true, :caching => false ) self. = {:Port => 8808} end |
Instance Attribute Details
#adapter ⇒ YARD::Server::Adapter
Returns the adapter to use for loading the web server.
17 18 19 |
# File 'lib/yard/cli/server.rb', line 17 def adapter @adapter end |
#libraries ⇒ Hash
Returns a list of library names and yardoc files to serve.
14 15 16 |
# File 'lib/yard/cli/server.rb', line 14 def libraries @libraries end |
#options ⇒ Hash
Returns a list of options to pass to the doc server.
8 9 10 |
# File 'lib/yard/cli/server.rb', line 8 def @options end |
#scripts ⇒ Array<String>
Returns a list of scripts to load.
21 22 23 |
# File 'lib/yard/cli/server.rb', line 21 def scripts @scripts end |
#server_options ⇒ Hash
Returns a list of options to pass to the web server.
11 12 13 |
# File 'lib/yard/cli/server.rb', line 11 def @server_options end |
Instance Method Details
#description ⇒ Object
40 41 42 |
# File 'lib/yard/cli/server.rb', line 40 def description "Runs a local documentation server" end |
#run(*args) ⇒ Object
44 45 46 47 48 49 50 51 |
# File 'lib/yard/cli/server.rb', line 44 def run(*args) optparse(*args) select_adapter.setup load_scripts load_template_paths adapter.new(libraries, , ).start end |