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'
if_modified_since
  • References/Ruby on Rails/Ruby/Classes/RDoc/RDoc::Servlet

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

2025-01-10 15:47:30
show_documentation
  • References/Ruby on Rails/Ruby/Classes/RDoc/RDoc::Servlet

show_documentation(req, res) Instance Public methods Displays documentation

2025-01-10 15:47:30
root_search
  • References/Ruby on Rails/Ruby/Classes/RDoc/RDoc::Servlet

root_search(req, res) Instance Public methods Generates a search index for the

2025-01-10 15:47:30
installed_docs
  • References/Ruby on Rails/Ruby/Classes/RDoc/RDoc::Servlet

installed_docs() Instance Public methods Returns an Array of installed documentation

2025-01-10 15:47:30
new
  • References/Ruby on Rails/Ruby/Classes/RDoc/RDoc::Servlet

new(server, stores, cache, mount_path = nil) Class Public methods Creates a

2025-01-10 15:47:30
documentation_page
  • References/Ruby on Rails/Ruby/Classes/RDoc/RDoc::Servlet

documentation_page(store, generator, path, req, res) Instance Public methods Fills

2025-01-10 15:47:30