How do I document my Rails project?

Updated 26 Apr, 2011 07:30 AM in Frequently Asked Questions

YARD looks in the lib and ext directories by default, ignoring your app code. To solve this problem, create a .yardopts file in the root of your project and specify the location of your sources. In this case, you'd want:

app lib - README

You can see more about setting up a .yardopts file here.

More from the knowledge base