How do I document my Rails project?
YARD looks in the
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,
app lib - README
You can see more about setting up a .yardopts file here.