SkyBirdSoar / cinch-rubydoc

A cinch plugin to put links to Ruby documentation

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Cinch::RubyDoc

Provides a RubyDoc plugin for a Cinch bot. The plugin reacts to the ri command and will provide links to rubydoc.info for the requested method, class, module or constant.

Dependencies

Requires Cinch (obviously) and yard.

You also need a local copy of YARD documentation for core and stdlib. You can generate it by running, at the root directory of the Ruby source directory:

yardoc -n 'ext/**/*.c' 'lib/**/*.rb' *.c

This will create a .yardoc directory that you can copy to the working directory of your bot to be picked up by the plugin.

About

A cinch plugin to put links to Ruby documentation

License:MIT License


Languages

Language:Ruby 100.0%