123456789_123456789_123456789_123456789_123456789_

Module: YARD::Server

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

Constant Summary

Class Method Summary

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.

Parameters:

  • path (String) —

    the pathname to register

Since:

  • 0.6.2

[ GitHub ] 

  


# 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