Instalacion

para agregar Yard a nuestro proyecto debemos agregar en el Gemfile

  group :development do
    gem 'yard'
  end

No debemos olvidarnos de agregar la gema en el group development para así evitar que la documentación esté abierta para cualquiera desde producción

Luego de hacer el bundle install podremos ejecutar el comando yard en nuestra terminal del proyecto

yard <command> [options]

Commands:
config   Views or edits current global configuration
diff     Returns the object diff of two gems or .yardoc files
doc      Generates documentation
gems     Builds YARD index for gems
graph    Graphs class diagram using Graphviz
help     Retrieves help for a command
ri       A tool to view documentation in the console like `ri`
server   Runs a local documentation server
stats    Prints documentation statistics on a set of files

Como a medida que el proyecto crezca es probable que se necesite de correr cada comando con varias opciones se puede crear un archivo .yardopts y guardar ahi dichas opciones.

Por ejemplo si nosotros quisieramos correr el siguiente comando

yardoc --no-private --protected app/**/*.rb - README LEGAL COPYING

podemos guardar dentro del archivo .yardopts

--no-private --protected app/**/*.rb - README LEGAL COPYING

Y de esa forma solo deberíamos correr el comando

yard