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
1
vote
1 answer

Documentation of Rails controllers using yard

When trying to create the documentation of my rails controller and the used parameters I'm getting stuck because yard seems to expect, that the parameters exists as method parameters. # Renders a list of items # @param params [Hash] the search…
PascalTurbo
  • 2,189
  • 3
  • 24
  • 41
1
vote
0 answers

How to ignore gems when running rake doc:rails?

When I run rake doc:rails it fails with an error don't know how to build task /Users/bigtunacan/.rvm/gems/ruby-1.9.3-p547@rails3/gems/rspec-activemodel-mocks-1.0.1/README.rdoc This appears then that it is trying to generate docs for the gems as well…
bigtunacan
  • 4,873
  • 8
  • 40
  • 73
1
vote
2 answers

RDoc : Change name of 'Atttributes:' section in ri-documentation

I'm using some meta-programming to generate a bunch of methods in ruby like so: class EmotionalObject def self.mood( name, *details ) define_method(name) do # ... end end mood :happy, #... mood :sad, #... mood :ebuillent,…
rampion
  • 87,131
  • 49
  • 199
  • 315
1
vote
2 answers

Gem installed rails 2.3.8, but not generate rdoc, how to fix?

I use gem install rails -v=2.3.8 to install rails, and it says rdoc and ri has been generated. But when I gem server, I can't open the rails doc in browser, it says doc_root/rails-2.3.8/rdoc/index.html not found I looked into…
Freewind
  • 193,756
  • 157
  • 432
  • 708
1
vote
1 answer

How do I programmatically automate .rmd file to PDF using knitr?

I can produce my reports rather quickly thanks to knitr and RDoc; however I want to streamline my process a little more by automatically generating the documents in my R script. Do ya'lls have any solutions or resources I could use to further…
C Ried
  • 290
  • 4
  • 15
1
vote
1 answer

Replacing RDoc with YARD in Rails 4.2

Is it possible to replace RDoc with YARD in Rails 4.2? I'd like rake doc:app to invoke YARD rather than RDoc. In my Gemfile I replaced sdoc with YARD (gem 'yard', '~> 0.8.0', group: :doc) with no luck.
anthonator
  • 4,915
  • 7
  • 36
  • 50
1
vote
1 answer

RDoc template customization

how can I change my default RDoc template for my gem environment. I'd like my gem server to look like this RDoc: http://getcloudkit.com/api/ and I've seen that design around so this shouldn't be so difficult.
ximus
  • 386
  • 3
  • 11
1
vote
3 answers

How to view core ruby documentation locally?

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…
lexsys
  • 537
  • 4
  • 24
1
vote
0 answers

Is generating ruby docs (ri, rdocs) via RVM gemset specific?

Using RVM I can generate docs using: rvm docs generate My question is do I have to do this for every gemset, or is it global? I frequently switch gemsets while working on different projects. I would like to have ri always available. Does the above…
MERM
  • 629
  • 7
  • 21
1
vote
1 answer

rdoc file how include content from local txt

I have a readme file in rails project and rake task which generate text file. I want include content from this file to my Readme.rdoc is it possible Everything I get after googling - some :include: directive I include it to my Readme.rdoc: == Some…
Volodymyr
  • 1,136
  • 3
  • 11
  • 28
1
vote
0 answers

Is there a way to use Yard Markup with RDoc in a Gem?

The exact question is: How can I instruct gem to generate my documentation with Yard. The old way using #has_rdoc doesn't function any more. I cannot find the method to do it using metadata in newer GemSpec versions. I would prefer using Yard over…
Andrei Beliankou
  • 684
  • 7
  • 17
1
vote
1 answer

Suppressing the ri and rdoc

I want to suppress the downloading of ri and rdoc while i install new gems on my windows machine. On linux we can edit .gemrc file. What is a way to do it in Windows?
Rishikesh Shukla
  • 317
  • 1
  • 12
1
vote
0 answers

Error with loading rdoc with rvm

I was trying to add docs through rvm, did not run into any errors, then when I went to look at File.open, received the following error. Any ideas? Mikes-MacBook-Pro:programs mwsage$ rvm docs generate Installing…
sage
  • 15
  • 7
1
vote
2 answers

Stop Rdoc from creating link on a string

I'm using RDoc for the first time, and I've run into one issue that's a bit bothersome. I have a line in my class documentation like the following: # * callingState I also have a class in that same project called State. When I generate the…
dsw88
  • 4,400
  • 8
  • 37
  • 50
1
vote
1 answer

how do you document padrino route methods using rdoc?

I'd like to use RDoc to document API calls in a web services app written in Padrino. Here's an example file: Analytics.controller :api do diable :layout ## # = /ping - test for response # The +ping+ command is a quick way to…
fearless_fool
  • 33,645
  • 23
  • 135
  • 217