I get an error message when loading my project, what happened?
If this happens, you should do the following in order:
- First and foremost, try running
yardagainst your project locally. In other words,
gem install yard, change to your project root directory, and type
- Load up your local docs and inspect them. If they are also broken, it must be something you're doing wrong with YARD. YARD has a mailing list for any support: email@example.com
- If the docs look fine to you, then it must be something on our end and you should open a ticket right here (not on Github) and we will take a look at the problem.