module YARD::Server

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

Public Class Methods

register_static_path(path) click to toggle source

Registers a static path to be used in static asset lookup. @param [String] path the pathname to register @return [void] @since 0.6.2

# File lib/yard/server.rb, line 8
def self.register_static_path(path)
  static_paths = Commands::StaticFileCommand::STATIC_PATHS
  static_paths.push(path) unless static_paths.include?(path)
end