Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Errors when building YARD index #1627

Closed
Pod-2-Ji-Woong-You opened this issue Dec 16, 2021 · 4 comments
Closed

Errors when building YARD index #1627

Pod-2-Ji-Woong-You opened this issue Dec 16, 2021 · 4 comments

Comments

@Pod-2-Ji-Woong-You
Copy link

Could anyone please help me troubleshoot this issue?
For context, I am trying to run yard gems in my project directory for solargraph. (https://solargraph.org/guides/yard)
However, when it tries to generate documentation for reek gem, it outputs following error:

[info]: Building yardoc index for gem: reek-6.0.6
[error]: The file `./docs/yard_plugin.rb' could not be loaded:
cannot load such file -- ./docs/yard_plugin.rb

Your help would be most appreciated.
@troessner
Copy link
Owner

What would be the easiest way for us to reproduce this?

@Pod-2-Ji-Woong-You
Copy link
Author

  1. Enable auto-generation of docs yard config --gem-install-yri
  2. Install reek gem install reek

Expected:

  • Documentation is auto-generated for reek gem

Actual:

  • It errors with following message:
$ gem install reek
Fetching: reek-6.0.6.gem (100%)
Successfully installed reek-6.0.6
Building YARD (yri) index for reek-6.0.6...
[error]: The file `./docs/yard_plugin.rb' could not be loaded:
cannot load such file -- ./docs/yard_plugin.rb

@anicholson-sq
Copy link

I had this issue too – I did this to workaround it:

$ pushd $(bundle show reek)
$ mkdir -p docs
$ touch docs/yard_plugin.rb
$ popd

and then yard was able to process reek with no issues…

@Pod-2-Ji-Woong-You
Copy link
Author

@anicholson-sq 's workaround solved my problem. Thank you. I'm closing this issue now.

@impepc impepc mentioned this issue Nov 12, 2022
Closed
typhoon2099 added a commit to typhoon2099/reek that referenced this issue Jul 2, 2024
@typhoon2099
Fix Yard doc auth generation.
01d00f5 
As per troessner#1627, Yard can't process Reek because `docs/yarn_plugin.rb` is
missing. It's not included in the Gem, so this PR adds it to correct
this error.

This was reported upstream in
lsegal/yard#1462, but it seems that it either
wasn't, or people were happy enough with the workaround (touching the
missing file in the Gem's installed location). The workaround doesn't
work when using `asdf`/`mise` with [default
Gems](https://mise.jdx.dev/lang/ruby.html#default-gems). If Yard's automatic
documentation is enabled (`yard config --gem-install-yri`) then the Ruby
build fails.
typhoon2099 added a commit to typhoon2099/reek that referenced this issue Jul 2, 2024
@typhoon2099
Fix Yard doc auto generation.
b9b7f92 
As per troessner#1627, Yard can't process Reek because `docs/yarn_plugin.rb` is
missing. It's not included in the Gem, so this PR adds it to correct
this error.

This was reported upstream in
lsegal/yard#1462, but it seems that it either
wasn't, or people were happy enough with the workaround (touching the
missing file in the Gem's installed location). The workaround doesn't
work when using `asdf`/`mise` with [default
Gems](https://mise.jdx.dev/lang/ruby.html#default-gems). If Yard's automatic
documentation is enabled (`yard config --gem-install-yri`) then the Ruby
build fails.
typhoon2099 added a commit to typhoon2099/reek that referenced this issue Jul 2, 2024
@typhoon2099
Fix Reek installation issue when Yard
80dc266 
As per troessner#1627, Yard can't process Reek because `docs/yarn_plugin.rb` is
missing. It's not included in the Gem, so this PR adds it to correct
this error.

This was reported upstream in
lsegal/yard#1462, but it seems that it either
wasn't, or people were happy enough with the workaround (touching the
missing file in the Gem's installed location). The workaround doesn't
work when using `asdf`/`mise` with [default
Gems](https://mise.jdx.dev/lang/ruby.html#default-gems). If Yard's automatic
documentation is enabled (`yard config --gem-install-yri`) then the Ruby
build fails.
typhoon2099 added a commit to typhoon2099/reek that referenced this issue Jul 2, 2024
@typhoon2099
Fix Reek installation issue when Yard is installed
40d6b2d 
As per troessner#1627, Yard can't process Reek because `docs/yarn_plugin.rb` is
missing. It's not included in the Gem, so this PR adds it to correct
this error.

This was reported upstream in
lsegal/yard#1462, but it seems that it either
wasn't, or people were happy enough with the workaround (touching the
missing file in the Gem's installed location). The workaround doesn't
work when using `asdf`/`mise` with [default
Gems](https://mise.jdx.dev/lang/ruby.html#default-gems). If Yard's automatic
documentation is enabled (`yard config --gem-install-yri`) then the Ruby
build fails.
@typhoon2099 typhoon2099 mentioned this issue Jul 2, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@troessner @anicholson-sq @Pod-2-Ji-Woong-You