I’ve been using rails and rails’ doc for quite a while now. And I always missed the search feature in docs. IMHO browser search in page is not the best solution. So i’ve spent this weekend trying to improve things a bit. This is more a proof of concept than a final product. http://voloko.ru/sdoc/rails/ and on github: http://github.com/voloko/sdocrails/tree/master (custom rdoc generator and template) Any feedback is appreciated. Thanks
Hi,
it looks great. one small issue - try to search 'link_to' and the last result item is:
secret_key_generator.rb railties/lib/rails_generator/secret_key_generator.rb
which has nothing to do with link_to .. see how did you perform the
search ![]()
tom
voloko wrote:
Very nice.
It has all the letters from "link_to" railties/<b>l</b>ib/ra<b>i</b>ls_ge<b>n</b>erator/secret_<b>k</
ey<b>_</b>genera<b>t</b><b>o</b>r.rb
It tries to find by exact match first (so link_to is always above) and then resorts to textmate-like matching (to find password() by "pswd").
i like it!
i assume you guys know about www.railsbrain.com? maybe it has some good ideas for this project
I use the command 'sdoc' to generate searchable doc for ruby1.8 and it gets wrong when generating SHTML. The error report is
/lib/sdoc/generators/shtml_generator.rb:282:in `to_json': source sequence is illegal/malformed (JSON::GeneratorError) ../lib/sdoc/generators/shtml_generator.rb:282:in `gen_search_index'
can it be fixed?