Ruby Yard Doc que no muestra ningún archivo
Pregunta
Esta es mi configuración:
- ruby 1.9.2 p290
- patio 0.8.1
La estructura de la carpeta no es una gema, simplemente código de rubí viejo:
. ├── classes │ ├── crawl.rb │ └── page.rb └── run.rb
El problema es que el patio no ve ningún archivo.
yard doc
produce esta salida:Files: 0 Modules: 0 ( 0 undocumented) Classes: 0 ( 0 undocumented) Constants: 0 ( 0 undocumented) Methods: 0 ( 0 undocumented) 0.00% documented
Cualquier ideas por qué no puede ver ninguno de mis archivos, o no es
Editar (información adicional):
Yarda tiene permisos para crear archivos.
Después de ejecutar el comando
yard doc
, mi directorio muestra archivos de patio:. .. .yardoc classes doc run.rb
Editar (Respuesta a comentarios sobre RDOC)
Una vez que elimine la carpeta Doc que crea el patio (RDOC se queja de ello)
rm -rf doc
, RDOC genera documentación y proporciona esta salidaFiles: 7 Classes: 6 ( 4 undocumented) Modules: 0 ( 0 undocumented) Constants: 2 ( 2 undocumented) Attributes: 18 (18 undocumented) Methods: 24 (20 undocumented) Total: 50 (44 undocumented) 12.00% documented
Editar (información adicional)
Yarda no funciona para mí en otras compilaciones de rubí, incluyendo MRI 1.8.7 y Jruby 1.6.4.Se comporta de la misma manera que se describe anteriormente
Solución
Yarda no documenta automáticamente todos los archivos de rubí en una estructura de directorios.Busca archivos en un directorio ./lib
.Si desea documentar a otros, debe especificar que en el comando o en un archivo .yardopts
ejemplo
yard classes/*.rb *.rb