RubyFlow The Ruby and Rails community linklog

×

The Ruby and Rails community linklog

Made a library? Written a blog post? Found a useful tutorial? Share it with the Ruby community here or just enjoy what everyone else has found!

Searchable Rails API Doc

by voloko —

I’ve been using rails and rails’ doc for quite a while now. And I always missed the search feature in docs. IMHO browser’s search in page is not the best solution. So I’ve spent this weekend trying to improve things a bit. Demo and code on github (custom rdoc generator and template).

Comments

This is completely awesome.

ratchetcat —

Reminds me of RailsBrain RailsBrains. I like the way all the information is cleverly nested though in yours.

Nathan —

2 ratchetcat: Thank you 2 wtf: Do you expect to see results about AR’s Polymorphic Associations? Even if there are no related functions/classes with “polymorphic” in a name? It’s practically impossible to search as you type on a fulltext index. Though it is possible to search through help headlines/custom tags. And it might be a good idea. Thanks. 2 Nathan: never seen it before. thanks for the link

voloko —

voloko: yes, sorry…that’s what I want for at least. I like searching method names, but the killer feature, and the thing that would really make it shine, is full test search.

wtf —

Post a comment

You can use basic HTML markup (e.g. <a>) or Markdown.

As you are not logged in, you will be
directed via GitHub to signup or sign in