Le document Ruby Yard ne montre aucun fichier
Question
Voici ma configuration :
- Rubis 1.9.2 p290
- Cour 0.8.1
La structure des dossiers n'est pas un joyau, juste du vieux code Ruby :
.
├── classes
│ ├── crawl.rb
│ └── page.rb
└── run.rb
Le problème est que Yard ne voit aucun fichier.
yard doc
donne ce résultat :
Files: 0
Modules: 0 ( 0 undocumented)
Classes: 0 ( 0 undocumented)
Constants: 0 ( 0 undocumented)
Methods: 0 ( 0 undocumented)
0.00% documented
Avez-vous une idée de la raison pour laquelle il ne peut voir aucun de mes fichiers ou ne le fait pas
Modifier (informations supplémentaires) :
Yard dispose des autorisations nécessaires pour créer des fichiers.
Après avoir exécuté le yard doc
commande, mon répertoire affiche les fichiers yard :
. .. .yardoc classes doc run.rb
Modifier (réponse au commentaire sur rdoc)
Une fois que j'ai supprimé le dossier doc créé par yard (rdoc s'en plaint) rm -rf doc
, rdoc génère de la documentation et fournit cette sortie
Files: 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
Modifier (informations supplémentaires)
Yard ne fonctionne pas pour moi sur d'autres versions de Ruby, notamment MRI 1.8.7 et jRuby 1.6.4.Il se comporte de la même manière que décrit ci-dessus
La solution
Yard ne documente pas automatiquement tous les fichiers Ruby dans une structure de répertoires.Il recherche des fichiers dans un ./lib
annuaire.Si vous souhaitez documenter les autres, vous devez le préciser dans la commande ou dans un fichier .yardopts
exempleyard classes/*.rb *.rb