--- !ruby/object:RI::MethodDescription 
aliases: []

block_params: 
comment: 
- !ruby/struct:SM::Flow::P 
  body: Can be used for quick navigation to the rdoc documentation. You can then define a search shortcut for your browser. E.g. in Firefox connect 'shortcut:rdoc' to http://localhost:8808/rdoc?q=%s template. Then you can directly open the ActionPack documentation by typing 'rdoc actionp'. If there are multiple hits for the search term, they are presented as a list with links.
- !ruby/struct:SM::Flow::P 
  body: "Search algorithm aims for an intuitive search:"
- !ruby/object:SM::Flow::LIST 
  contents: 
  - !ruby/struct:SM::Flow::LI 
    label: "1."
    body: first try to find the gems and documentation folders which name starts with the search term
  - !ruby/struct:SM::Flow::LI 
    label: "2."
    body: search for entries, that <b>contain</b> the search term
  - !ruby/struct:SM::Flow::LI 
    label: "3."
    body: show all the gems
  type: :NUMBER
- !ruby/struct:SM::Flow::P 
  body: If there is only one search hit, user is immediately redirected to the documentation for the particular gem, otherwise a list with results is shown.
- !ruby/struct:SM::Flow::H 
  level: 3
  text: Additional trick - install documentation for ruby core
- !ruby/struct:SM::Flow::P 
  body: "Note: please adjust paths accordingly use for example 'locate yaml.rb' and 'gem environment' to identify directories, that are specific for your local installation"
- !ruby/object:SM::Flow::LIST 
  contents: 
  - !ruby/struct:SM::Flow::LI 
    label: "1."
    body: install ruby sources
  - !ruby/struct:SM::Flow::VERB 
    body: "  cd /usr/src\n  sudo apt-get source ruby\n"
  - !ruby/struct:SM::Flow::LI 
    label: "2."
    body: generate documentation
  - !ruby/struct:SM::Flow::VERB 
    body: "  rdoc -o /usr/lib/ruby/gems/1.8/doc/core/rdoc    #        /usr/lib/ruby/1.8 ruby1.8-1.8.7.72\n"
  type: :NUMBER
- !ruby/struct:SM::Flow::P 
  body: By typing 'rdoc core' you can now access the core documentation
full_name: Gem::Server#rdoc
is_singleton: false
name: rdoc
params: (req, res)
visibility: public
