Yard: Specify a different path for the compiled doc (instead of doc/)?

Question

Is there any way to tell Yard not to clutter up my Rails project's doc/ folder? I'd like it to save its files in doc/yard/ or something like that. Sadly I didn't find any option for that.

Thank you for help.

Polythene

Answer 1

yardoc --output-dir /path/to/yard/doc app.rb

Bilyeu

Thank you. I was too occupied searching for something "I dont know what" instead of taking a look at yard -h... – Polythene

Answer 2

You probably want to conifgure this and forget about it. If so, .yardopts in your project root directory is the way to go - you just write the option in the file, one per line, so something like:

$ echo --output-dir /path/to/yard/doc >> .yardopts

(or use vi or whatever to edit the file by hand)

With that in place you can just do

$ yard doc

Defame