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.

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

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants