プロジェクト

全般

プロフィール

Vote #71872

完了

rake yard does not work for generating documentation.

Admin Redmine さんが約4年前に追加. 約4年前に更新.

ステータス:
Closed
優先度:
通常
担当者:
-
カテゴリ:
Documentation_24
対象バージョン:
開始日:
2022/05/09
期日:
進捗率:

0%

予定工数:
category_id:
24
version_id:
49
issue_org_id:
10965
author_id:
55838
assigned_to_id:
0
comments:
15
status_id:
5
tracker_id:
1
plus1:
0
affected_version:
closed_on:
affected_version_id:
43
ステータス-->[Closed]

説明

Procedure to reproduce the trouble :

Install Yard : @gem install yard@

Generate documentation, from root redmine folder : @rake yard@

Symptoms are :

  • rake yard ends with error :
    rake aborted!
    Don't know how to build task 'yard'

(See full trace by running task with --trace)

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

journals

Thanks, fixed with r9701.
--------------------------------------------------------------------------------
Applied the fix but nothing has changed .... still having the same error.

Best regards,
--------------------------------------------------------------------------------
Did you @bundle install@?
--------------------------------------------------------------------------------
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":http://gembundler.com/man/bundle-install.1.html#REMEMBERED-OPTIONS, 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=development@
# @rake 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.
--------------------------------------------------------------------------------
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 < version:2.0.0, that's why I considered it as a regression.
--------------------------------------------------------------------------------
It doesn't make sense to have a source:/branches/2.0-stable/lib/tasks/yardoc.rake and not have @yard@ task available because of a missing entry in Gemfile, does it?
--------------------------------------------------------------------------------
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 ....
--------------------------------------------------------------------------------
You're right, it's merged for 2.0.1.
--------------------------------------------------------------------------------

Admin Redmine さんが約4年前に更新

  • カテゴリDocumentation_24 にセット
  • 対象バージョン2.0.1_49 にセット

他の形式にエクスポート: Atom PDF

いいね!0
いいね!0