I cannot find Ruby-opencv 0.0.10 API manual on the web. On the web, I just find version 0.0.7 document, it seems out of date.
Then I try to create rdoc myself, but gem rdoc ruby-opencv cannot work.
gem rdoc ruby-opencv
Parsing documentation for ruby-opencv-0.0.10
unable to convert "\xE0" from ASCII-8BIT to UTF-8 for lib/opencv.so, skipping
How to solve it? Any suggestion is welcome, thanks in advance.
I finally find a way to get the API doc. It's quiet simple.
Just go to the source files dirctory of gem Ruby-opencv, then run rdoc there.
In myown machine, it's as following
cd /home/uncutstone/.rvm/gems/ruby-2.0.0-p353/gems/ruby-opencv-0.0.10/ext
rdoc --ri
Related
I have made a Ruby gem recently now I want to make a documentation for that gem using rdoc now I have installed the rdoc gem in my project and ran the following command on the windows CMD.
rdoc
this created a doc folder on my project now how can I push this doc folder on rdoc.info website so that my documentation gets displayed there. I looked on the official rdoc documentation but did not found any source how to push your docs on the website. Thanks in advance
I have installed Ruby 2.0.0 with rvm and want to have local html documentation. So I run
$ rvm docs generate
Installing rdoc-data................................................................
Generating gems documentation.......
$ rvm docs open
rdoc docs are missing, perhaps run 'rvm docs generate' first?
What is wrong?
Here's what works for me for RVM:
rdoc $MY_RUBY_HOME -o ~/ruby_docs
That puts the HTML documentation for the core and standard libraries in your $HOME/ruby_docs directory. Then, if you're on Mac OS, simply run:
open ~/ruby_docs/index.html
or navigate to the directory and open index.html somehow for other OSes.
I recommend using this app https://itunes.apple.com/gb/app/dash-docs-snippets/id458034879?mt=12 Allows you to access documentation for any language.
Try gem update rdoc and then generate the docs. I had the same issue and this solved it.
I am trying to search TCPSocket ruby class documentation with ri but it shows nothing. Most of the gems are shown. I am using rvm, and require 'socket' works perfectly. How to fix this?
Try using:
gem rdoc --all
The documentation says:
--all Generate RDoc/RI documentation for all
installed gems
You can find these things out by typing:
gem help
or
gem help rdoc
at the command line.
You might want to throw on --overwrite to overwrite existing documentation.
Old versions of Ruby, around 1.8, didn't always have the core and/or std-lib documentation generated. There's a gem you can install that patches that, but I don't remember what it was right now.
I built a gem for my own usage and when I want to install it I get the following:
$ gem install mygem
Successfully installed mygem-0.0.1
1 gem installed
Installing RDoc documentation for mygem-0.0.1...
Invalid output formatter
For help on options, try 'rdoc --help'
The gem works fine, but I would like to know what is causing this since I never saw it when installing any other gem. Looks like it is somehow related to RDoc but I couldn't find anything searching about it.
Thanks in advance.
Can you check your RDoc output format? A similar question was found here
https://github.com/tenderlove/paddle/issues/1
I've never seen the point of installing the ri and rdoc for gems and my .gemrc file has --no-ri and --no-rdoc set. Since every gem includes ri and rdoc info, I just wondered if I'm missing something? Is there any advantage to installing the ri and rdoc for a gem?
Thanks
Chris
Summary
If you don't install the ri and rdoc, you don't lose anything of great value. I thought perhaps it got used in some of the IDEs (I'm an Emacs user) but that doesn't seem to be the case.
The point of installing ri documentation is simply that you can use the "ri" command to access method-by-method documentation. For an example, try: "ri String#reverse". Exit by pressing "q".
To try out RDoc documentation, run "gem server" and then connect to localhost:8808 in your browser. I find it useful - you can even click on a method name to see the source code. Of course, you can just go into your gems folder and open the HTML files in the doc folder.
An alternate way to access RDoc is the gemdoc command. See http://www.stephencelis.com/2008/06/12/bashfully-yours-gem-shortcuts.html. That's quite handy, IMHO.
Anyway, you can be lazy and wait until you need the RDoc documentation, and then generate it with "gem rdoc ".
Personally, I'm installing my gems without rdoc and ri, too, because normally you can find all the documentation you need on the internet as well (i.e. www.rdoc.info), so there's no need for investing hard disk space and time the generation takes
Install it if you want locally available documentation for the gem.
This article gives a great why and how of using ri:
http://jstorimer.com/ri.html
Best point on that list is #1: ri understands Ruby. For instance:
$ ri ActiveRecord::Base#save
(from gem activerecord-3.2.8)
Implementation from ActiveRecord::Persistence
[...]
(from gem activerecord-3.2.8)
Implementation from ActiveRecord::Validations
[...]
Notice the method is found even if not directly on ActiveRecord::Base itself.