ri > RDoc::Servlet

man perldoc info pydoc3 ri search

📖 Description

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'

🚀 Quick Reference

Use Case	Command	Description
Start ri server	ri --server	Starts a WEBrick server on port 8214 to browse ri documentation
Start gem server	gem server	Starts a WEBrick server on port 8808 to browse gem documentation
Mount servlet on custom server	server.mount '/', RDoc::Servlet	Mounts RDoc::Servlet at the root of a custom WEBrick server
Mount servlet with custom path	server.mount '/rdoc', RDoc::Servlet, '/rdoc'	Mounts RDoc::Servlet at a custom path with base path adjustment
Access documentation	http://localhost:8000	Navigate to the server's URL to view documentation

🏷️ Class Methods

• new

🛠️ Instance Methods

• asset
• asset_dirs
• do_GET
• documentation_page
• documentation_search
• documentation_source
• error
• generator_for
• if_modified_since
• installed_docs
• not_found
• options
• ri_paths
• root
• root_search
• show_documentation
• store_for

📋 Attributes

• asset_dirs (attr_reader)
• options (attr_reader)

📖 Description 🚀 Quick Reference 🏷️ Class Methods 🛠️ Instance Methods 📋 Attributes