.document doesn't work correctly

[koraktor]

I try to use the .document file in my project steam-condenser. As my project is split into several languages, I tried to use .document to only parse the Ruby files. So I added the following line:

ruby/lib/**/*.rb

This looks right for me and works with Dir#glob in the root folder of my project. But rdoc.info only displays a few classes located inside a direct subdirectory of the ruby directory.

[zapnap]

Thanks for reporting the bug! This is fixed in the latest build (now deployed) and the affected docs have been regenerated. Take a look at http://docs.github.com/koraktor/steam-condenser and http://rdoc.info/projects/koraktor/steam-condenser to confirm

I also noticed that your README isn't showing up because it's not in the root of the project (which is where we look for it by default).

[koraktor]

Thanks for fixing this. Is there any way to change the location of the README?

[zapnap]

If you have a suggestion for how this might work, feel free to open a feature request for this on the zapnap/rdocinfo project and we'll consider it. Right now only top-level READMEs are supported (which is the common case).

[zapnap]

I talked with Loren about this earlier today and he said he'd consider adding support for a standard .yardopts file in YARD; this could be used to set a custom README path. File another ticket for this and we'll address it when these things take shape!

[zenhob]

This still doesn't work for me.

$ cat .document
app/**/*.rb
lib/**/*.rb
*.rdoc

It picks up the libs but not the rdocs. Is this by design?

[zapnap]

rdocinfo uses the standard options that YARD itself supports; the contents of the .document file are essentially just passed to yardoc for generation. I don't believe YARD generates documentation for .rdoc files (??). Try it on the command line first using

yardoc app/**/*.rb lib/**/*.rb *.rdoc

and see what that yields for you.