Question

I use the command

rake doc:app

to generate some rudimentary documentation for my rails app. It's always worked fine in the past. Yesterday I upgraded by app from Ruby 1.9.3 to 2.1.1, and Rails 3.2 to 4.1. Everything is working fine with the app, so I went to regenerate documentation for the first time in a few weeks, and it failed. I ran the command above and got the following error message:

rake aborted!                                                              
Don't know how to build task 'README.rdoc'                                 
/home/vagrant/.rvm/gems/ruby-2.1.1/bin/ruby_executable_hooks:15:in `eval'  
/home/vagrant/.rvm/gems/ruby-2.1.1/bin/ruby_executable_hooks:15:in `<main>'
Tasks: TOP => doc:app => doc/app/index.html                                
(See full trace by running task with --trace)

I believe this is the standard error message rake delivers for a task it doesn't know. Like if I ran

rake foo

It gives the exact thing, but with 'foo' instead of 'README.rdoc'. I get the same results when I run

bundle exec rake doc:app

I'm using rake 10.2.2. Any idea what's going on?

Was it helpful?

Solution

Create a README.rdoc in the project root folder. You might have removed it or replaced it with a README with another filetype extension.

Licensed under: CC-BY-SA with attribution
Not affiliated with StackOverflow
scroll top