Module: YARD::Server

Defined in:
lib/yard/autoload.rb,
lib/yard/server.rb,
lib/yard/server/router.rb,
lib/yard/server/adapter.rb,
lib/yard/server/rack_adapter.rb,
lib/yard/server/commands/base.rb,
lib/yard/server/static_caching.rb,
lib/yard/server/webrick_adapter.rb,
lib/yard/server/library_version.rb,
lib/yard/server/doc_server_helper.rb,
lib/yard/server/commands/list_command.rb,
lib/yard/server/doc_server_serializer.rb,
lib/yard/server/commands/frames_command.rb,
lib/yard/server/commands/search_command.rb,
lib/yard/server/commands/library_command.rb,
lib/yard/server/commands/static_file_command.rb,
lib/yard/server/commands/display_file_command.rb,
lib/yard/server/commands/library_index_command.rb,
lib/yard/server/commands/display_object_command.rb

Overview

Namespace for classes and modules that handle serving documentation over HTTP

Implementing a Custom Server

To customize the YARD server, see the Adapter and Router classes.

Rack Middleware

If you want to use the YARD server as a Rack middleware, see the documentation in RackMiddleware.

Since:

  • 0.6.0

Defined Under Namespace

Modules: Commands, DocServerHelper, StaticCaching Classes: Adapter, DocServerSerializer, FinishRequest, LibraryNotPreparedError, LibraryVersion, NotFoundError, RackAdapter, RackMiddleware, Router, WebrickAdapter, WebrickServlet

Class Method Summary collapse

Class Method Details

.register_static_path(path) ⇒ void

This method returns an undefined value.

Registers a static path to be used in static asset lookup.

Since:

  • 0.6.2



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

def self.register_static_path(path)
  Commands::StaticFileCommand::STATIC_PATHS.push(path)
end