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
3
votes
1 answer

RDoc for script without classes/procedures/objects

Is it possible to document ruby script, using RDoc or any other documentation generator , if it does not have any structure inside?
Timb
  • 31
  • 2
3
votes
1 answer

How can I make rdoc properly read method arguments from my c extension?

all, I'm using rdoc to generate documentation for my Ruby code which contains C-extensions, but I'm having problems with my method arguments. Rdoc doesn't parse their names correctly and instead uses p1, p2 etc. So, first off, my extensions are…
hyperlogic
  • 7,525
  • 7
  • 39
  • 32
2
votes
2 answers

Trying to find a reference to the manual but can't

Simple question, what is the best way on windows to search the documentation. This time I was wanting information on 'while'(resolved now by google) but I still can't can't get ri or the chm documentation on windows to give a result to while. If I…
sayth
  • 6,696
  • 12
  • 58
  • 100
2
votes
0 answers

Customize RDoc::ClassModule#description

I'm attempting to write a new generator for RDoc but I cannot figure out how to customize the description output for an RDoc::ClassModule object. Currently it looks like this:

Gist API is... lacking at the moment.

I want…
Ryan Bigg
  • 106,965
  • 23
  • 235
  • 261
2
votes
1 answer

How do I render a verbatim/code/pre plus sign with RDoc markup?

Using RDoc markup and generating docs with Yard, I'm trying to document some command output that has a line like: +----------------------------------+ ...but can't figure out how to achieve this. How can I end up with HTML:
turboladen
  • 698
  • 1
  • 9
  • 14
2
votes
4 answers

Making RDoc Ruby Gem Default on Mac OS X

I've recently installed RDoc version (2.4.3) through Ruby gems to replace the one shipped with Mac OS X (version 1.0.1). Unfortunately, I can still only use RDoc 1.0.1 when I call run "rdoc" at the command line. rdoc -v returns: RDoc V1.0.1 -…
jkale
  • 83
  • 3
  • 8
2
votes
0 answers

Roxygen link to the "[" method

In my R package, I implemented the [ (indexing) operator for my class: #' Some title #' @export setMethod("[", list(x="MyClass"), function(x, i, j, ...) { # Some code }) Now, in the package documentation I want to link to the manual entry for…
Migwell
  • 18,631
  • 21
  • 91
  • 160
2
votes
1 answer

How can I define sections without === Headings for RDoc::usage()?

I like to generate man pages using '--help' output via help2man and txt2man. Ruby's RDoc system is very convenient, but I can't seem to configure RDoc::usage in exactly the way that I want. Here's a sample script: #!/usr/bin/env ruby # # ===…
guns
  • 10,550
  • 3
  • 39
  • 36
2
votes
1 answer

RDoc not generating source files

I'm using Rdoc 2.58 with Ruby 1.9.2p138. When I generate my rdoc files using the Darkfish format (which is the only option), I'm not getting the source code previews with it. There are no error messages, and the HTML files are being generated for…
philosodad
  • 1,808
  • 14
  • 24
2
votes
2 answers

Generating RDOCs for locally installed gems

I am trying to contribute to a gem I recently took interest in - Nesta. The developer has done a great job in creating one of the lightest, thinest CMSs you can find and I want to document it. I have read through the code and commented on a few…
Igbanam
  • 5,904
  • 5
  • 44
  • 68
2
votes
6 answers

what is an easy way to access documentation for ruby-based gems locally?

I have a bunch of gems that I use, but am often disconnected and want to be able to pull up documentation on the gems locally. so far, the only thing I've been able to do is actually go to the gem library and find the README. Is there a better way…
Satchel
  • 16,414
  • 23
  • 106
  • 192
2
votes
3 answers

How do I customize the rdoc Darkfish stylesheet?

I'm using Rake to generate RDoc documentation for my project, but I really hate the gray-on-gray style that Darkfish seems to generate. I'm happy with everything else, I'd just like to make the color scheme a little more readable. Here's my rake…
decitrig
  • 778
  • 5
  • 23
2
votes
2 answers

Rails install fails on Ubuntu 10.10

I'm trying to install rails on Ubuntu 10.10, but get File not found: lib every time. Ruby and Rubygems have been installed correctly. I've seen this problem posted all over the web but no solutions work for me. I reinstalled rdoc and I still get…
John
  • 5,835
  • 8
  • 28
  • 36
2
votes
1 answer

How to show constant value in rdoc?

Is it possible to have rdoc also show value of constant, not just it's comment? At the moment it's generating Constants DEFAULT_CONFIG_FILE Default configuration file location what I would like to get is Constants DEFAULT_CONFIG_FILE =…
graywolf
  • 7,092
  • 7
  • 53
  • 77
2
votes
1 answer

How to specify no ri/rdoc exists for a gem so user doesn't get warning when trying to install

A gem I'm authoring doesn't have any inline ri/rdoc of any kind, so when users gem install it they get warnings when rubygems tries to compile the docs: Successfully installed mygem-0.0.1 1 gem installed Installing ri documentation for…
tfe
  • 32,666
  • 2
  • 27
  • 24