Questions tagged [rdoc]

RDoc is the default embedded documentation generator for Ruby. Rdoc generates structured documentation that can be accessed via a web browser or the command-line by analyzing the code and specially formatted comments. Even in the absence of comments, rdoc will generate documentation using a programs structure.

RDoc analyzes Ruby source code to generate documentation. In the absence of comments, Rdoc uses the programs structure to produce documentation. With comments, which can be specially formatted using RDoc Markup, RDoc can create very detailed and useful documentation. Documentation generated via rdoc is accessible through the command line using ri. The RDoc Project's source code repository is hosted via github. RDoc was designed by Dave Thomas.

214 questions
0
votes
1 answer

Rdoc, YARD and irb, using intern method on an array?

I was just trying to generate the documentation for my gem, and upon running either rdoc or yard I got the error undefined method `intern' for []:Array What is going on? I've trying reinstalling everything, and I'm on ruby 2.3.1. Also, from what I…
thesecretmaster
  • 1,950
  • 1
  • 27
  • 39
0
votes
1 answer

Can't get RDoc to suppress cross-references for a specific word

I'm using the jeweler gem when developing new gems. As part of the skeleton, it sets up a set of RDoc related rake tasks - the main one being rake rdoc. As far as I can tell from the Rakefile, this task uses the rake/rdoctask library to generate…
Thomas Watson
  • 6,507
  • 5
  • 33
  • 43
0
votes
4 answers

How do I enable "Click to toggle source" button in Ruby RDoc?

When using the Darkfish RDoc generator to generate RDoc documentation, next to methods there is a Click to toggle source button next to each method. It isn't working for me when I generate my documentation, so how do you get that feature to work, do…
ab217
  • 16,900
  • 25
  • 74
  • 92
0
votes
2 answers

Simple Rdoc Question about documentation modifiers

I have this method in a class I am using def binary_search(a,x) # ... end and I want in the documentation for the parameters to appear as def binary_search(array, key) and not binary_search(a,x). I have tried to use the documentation modifier #…
ab217
  • 16,900
  • 25
  • 74
  • 92
0
votes
1 answer

Accessing rdoc files from one place

In Ruby, if you run the command gem server it will present you with a web page of documentation for all the gems you have installed on your machine. Can something similar be done for your local documentation, so that all of your local rdoc…
ab217
  • 16,900
  • 25
  • 74
  • 92
0
votes
1 answer

Cannot find a class

You can use Octopussy like this: Octopussy.user "my_account" But I cannot find the "user" method in the API documentation http://rdoc.info/github/pengwynn/octopussy/master/Octopussy According to the documentation that module is extended by…
never_had_a_name
  • 90,630
  • 105
  • 267
  • 383
0
votes
2 answers

How to use methods define in http://www.rubydoc.info/ site

I have open rails console and want to use pluralize method but i am getting error as NoMethodError: undefined methodpluralize' for main:Object` pluralize(1, 'person') i can see the documentation for this method here…
Lokesh Harjani
  • 119
  • 1
  • 9
0
votes
1 answer

rake not working because "cannot find rdoc"

This is probably part of a larger problem because I've been troubleshooting one problem only to encounter a new one. I finally deleted the whole directory and pulled down a fresh copy, but I'm still having the same problem: $ rake db:migrate Could…
0
votes
1 answer

When running rdoc the folders 'images' and 'js' are not copied to the doc dir

I am running rdoc 2.5.9 and when I generate rdoc with the default 'Darkfish' template just by running: rdoc app README in my rails root folder. All the files are generated but the 'images' and 'js' folder is missing in the doc directory. So I need…
huug
  • 1,059
  • 2
  • 11
  • 25
0
votes
2 answers

Where in a Rails application is the RDoc title set?

Documentation generated for a Rails application by rake doc:app gets a default title of "Rails Application Documentation". The Rake sets this: rdoc.title = ENV['title'] || "Rails Application Documentation" I can change this by doing $…
starfry
  • 9,273
  • 7
  • 66
  • 96
0
votes
1 answer

bundle install fails with rdoc Internal Server Error

while trying to install a Ruby application with Bundler, the dependent rdoc gem fails with an Internal Server Error: user@machine:/home/user/someapp# bundle Fetching gem metadata from http://rubygems.org/........... Fetching gem metadata from…
RoelF
  • 7,483
  • 5
  • 44
  • 67
0
votes
1 answer

Using RDoc and Executing Code - Annotating

I have a series of Ruby methods andI would like to dump their return values out to a formatted report. However, I'd also like to annotate these results (i.e. with descriptions of what the value is), and I was wondering if I could use the existing…
Colin Ramsay
  • 16,086
  • 9
  • 52
  • 57
0
votes
1 answer

Create doc for rails, plugins, app in a single file

I was wondering what the best option for generating doc for rails, its plugin and the app in one single file that I can navigate. I've been using rdoc but that creates multiple files, yard is too slow and hanna gets stuck at random places. Any help?…
sent-hil
  • 18,635
  • 16
  • 56
  • 74
0
votes
1 answer

How can I browse local project documentation

Is there any Rails way to browse the documentation generated in local doc/ folder with the command rake doc:app? I know I could configure Apache to serve the files in the doc folder but I would be surprised if Rails didn't provide a way to do that…
fkoessler
  • 6,932
  • 11
  • 60
  • 92
0
votes
1 answer

Pry show-source not showing implementation

Using Pry show-source it's not showing me the method implementation as I expected: [2] pry(main)> show-source Object#extend From: eval.c (C Method): Owner: Kernel Visibility: public Number of lines: 3 static VALUE rb_obj_extend(argc, argv,…
Daniel Romero
  • 1,581
  • 1
  • 20
  • 33