Type:
Class

This is a WEBrick servlet that allows you to browse ri documentation.

You can show documentation through either `ri –server` or, with RubyGems 2.0 or newer, `gem server`. For ri, the server runs on port 8214 by default. For RubyGems the server runs on port 8808 by default.

You can use this servlet in your own project by mounting it on a WEBrick server:

require 'webrick'

server = WEBrick::HTTPServer.new Port: 8000

server.mount '/', RDoc::Servlet

If you want to mount the servlet some other place than the root, provide the base path when mounting:

server.mount '/rdoc', RDoc::Servlet, '/rdoc'
generator_for

generator_for(store) Instance Public methods Instantiates a Darkfish generator

2015-05-04 10:38:02
not_found

not_found(generator, req, res) Instance Public methods Returns a 404 page built

2015-05-04 10:49:24
documentation_search

documentation_search(store, generator, req, res) Instance Public methods Creates

2015-05-04 10:25:41
documentation_source

documentation_source(path) Instance Public methods Returns the

2015-05-04 10:29:40
root

root(req, res) Instance Public methods Generates the root page on res

2015-05-04 10:58:05
store_for

store_for(source_name) Instance Public methods Returns an

2015-05-04 11:06:17
if_modified_since

if_modified_since(req, res, path = nil) Instance Public methods Handles the

2015-05-04 10:42:05
error

error(exception, req, res) Instance Public methods Generates an error page for

2015-05-04 10:30:33
asset

asset(generator_name, req, res) Instance Public methods Serves the asset at

2015-05-04 10:08:18
ri_paths

ri_paths(&block) Instance Public methods Enumerates the ri paths. See

2015-05-04 10:52:53