Defect #10965
closed
rake yard does not work for generating documentation.
Added by Antoine Rodriguez over 12 years ago.
Updated over 12 years ago.
Description
Procedure to reproduce the trouble :
- Install Yard :
gem install yard
- Generate documentation, from root redmine folder :
rake yard
Symptoms are :
Environment:
- Redmine version: 2.0.0.stable
- Ruby version: 1.8.7 (x86_64-linux)
- Rails version: 3.2.3
- Environment: production
- Database adapter: MySQL
- Yard : 0.8.1
Files
|
output.txt (38.5 KB)
output.txt |
output of the "rake yard" command containing warnings |
Antoine Rodriguez, 2012-05-22 13:44
|
|
- Status changed from New to Resolved
- Target version set to 2.0.1
- Resolution set to Fixed
Thanks, fixed with r9701.
Applied the fix but nothing has changed .... still having the same error.
Best regards,
I've installed 2.0.0 with the bundle at rubyforge.
Then I've applied the 3 releases(up to r9701)
I've restarted
And tried under production and then under development RAILS_ENV var
Did I miss something ?
Best regards,
Yes, you need to do a bundle install to update your bundle.
I've made it and nothing changed ... still having the issue.
However I've already installed yard before as I've mentioned in the ticket. shall I uninstall it and make a bundle install ?
rake yard is designed to run on development (like rdoc) so you have to include the development group in your bundle and run rake in development RAILS_ENV.
If you have bundle install --without development ... in the first place then bundle install won't change your bundle since --without is a remembered option, so you have to delete and recreate your bundle.
I've deleted the .bundle folder inside the redmine root folder and made a bundle install without any other option.
After the completion of the command I've made the following :
export RAILS_ENV=developmentrake yard
rake yard worked but with a lot of warnings.
At the end the doc has been generated into the doc/app folder inside the redmine root folder.
You can appreciate the warnings inside the output.txt that I've uploaded with this message.
Thank you very much. Original bug is fixed.
- Target version changed from 2.0.1 to 2.1.0
Not sure that this one is really needed in the core. I think that Gemfile.local would be a more appropriate place to add it for those who want to use extra rake tasks. Any suggestions?
What would be the advantages of putting it in the Gemfile.local instead than the core knowing that it is equaly important than the project ?
Best regards,
Antoine Rodriguez wrote:
What would be the advantages of putting it in the Gemfile.local instead than the core knowing that it is equaly important than the project ?
I think that > 99% of users won't need it.
I would treat it just as rdoc?
Rake task was already here in < 2.0.0, that's why I considered it as a regression.
having documentation up to date is being sure of having more participation in the project and having more plugins ....
For core developpers is also a good tool ....
- Status changed from Resolved to Closed
- Target version changed from 2.1.0 to 2.0.1
You're right, it's merged for 2.0.1.
Also available in: Atom
PDF
Updated by 
Updated by 
Updated by