rmanalan / bdoc Goto Github PK

I'm not even certain it's not already possible to have bdoc give you access to the core and std-lib api as well. If so, could we see that in the docs?

Line 28:

  installed_gems = Gem::SourceIndex.from_installed_gems.gems.map{|k,v|v}

gives a rubygems deprecation warning with rubygems 1.8.10

As far as I found out, this helps:

  installed_gems = Gem::Specification

The best would be to test against the rubygems version and use either on or the other.

I get this exception immediately after running 'bdoc' on windows:
I have the latest version of the ruby 1.9.2 windows installer.

(erb):167:in concat': incompatible character encodings: IBM437 and UTF-8 (Encoding::CompatibilityError) from (erb):167:ingenerate_index'
from C:/Dev/Ruby192/lib/ruby/1.9.1/erb.rb:753:in eval' from C:/Dev/Ruby192/lib/ruby/1.9.1/erb.rb:753:inresult'
from C:/Dev/Ruby192/lib/ruby/gems/1.9.1/gems/bdoc-0.3.2/lib/bdoc.rb:50:in generate_index' from C:/Dev/Ruby192/lib/ruby/gems/1.9.1/gems/bdoc-0.3.2/lib/bdoc.rb:56:inopen'
from C:/Dev/Ruby192/lib/ruby/gems/1.9.1/gems/bdoc-0.3.2/bin/bdoc:4:in <top (required)>' from C:/Dev/Ruby192/bin/bdoc:19:inload'
from C:/Dev/Ruby192/bin/bdoc:19:in `

I'm getting the error below after running "bundle gem update." Looks like a new version of Launchy breaks the old API that Bdoc is using.

WARNING: You made a call to a deprecated Launchy API. This call should be changed to 'Launchy.open( uri )'
WARNING: I think I was able to find the location that needs to be fixed. Please go look at:
WARNING:
WARNING: /Users/tsummerville/.rvm/gems/ruby-1.9.2-p180/gems/bdoc-0.3.6/lib/bdoc.rb:64:in `open'
WARNING: def open
WARNING: generate_index
WARNING: Launchy::Browser.run(output_index)
WARNING: end
WARNING: end
WARNING:
WARNING: If this is not the case, please file a bug. Please file a bug at https://github.com/copiousfreetime/launchy/issues/new
Failure in opening /var/folders/4_/j51z53hx4kv_s2fpkb60cg100000gn/T/bdoc.html with options {}: No application found to handle scheme ''. Known schemes: file, ftp, http, https

E.g., I have installed Capistrano 2.5.10 but bdoc defaults to displaying the docs for the version installed in /System/Library/Frameworks/Ruby.framework/Versions/1.8/usr/lib/ruby/gems/1.8, 2.5.2 by default. It should choose the latest version by default I think.

Thanks for a very useful tool!
Andy

I have firefox on win xp
when I generate bdoc tempflie the links to rdocs start with
c:/ruby/
however firefox does not translate them automatically to file:///c:/ruby
I noticedd that if I enter c:\ruby in address bar firefox automatically translates them to file:///c:/ruby
I wonder if I should fix something on firefox side on winxp or make bdoc prepend file:/// to the generated links.

Line 15 of README.rdoc reads:

Check out the demo http://manalang.com/bdoc

but the link redirects to http://manalang.com/ where no info on bdoc can be found

Tried to use bdoc on Google Chrome 5.0.375.9 on Mac and found out that when I click on method name link then instead of showing documentation in right pane it opens it in new tab.

Haven't yet investigated why this happens, probably that's more related to hanna template than to bdoc? Do you have any idea?