2012-05-18 3 views
2

Ceci est ma configuration:doc cour Ruby ne montrant aucun fichier

  • Ruby 1.9.2 P290
  • cour 0.8.1

La structure du dossier n'est pas un bijou, tout simplement vieux Ruby code:

. 
├── classes 
│   ├── crawl.rb 
│   └── page.rb 
└── run.rb 

Le problème est que la cour ne voit aucun fichier.

yard doc cède cette sortie:

Files:   0 
Modules:   0 ( 0 undocumented) 
Classes:   0 ( 0 undocumented) 
Constants:  0 ( 0 undocumented) 
Methods:   0 ( 0 undocumented) 
0.00% documented 

Toutes les idées pourquoi il ne peut pas voir aucun de mes fichiers, ou non


Modifier (Informations complémentaires):

Yard a des autorisations pour créer des fichiers.

Après je lance la commande yard doc, mon répertoire affiche les fichiers de cour:

.  ..  .yardoc classes doc  run.rb 

Modifier (réponse à des commentaires au sujet rdoc)

Une fois que je supprime le dossier doc que la cour crée (rdoc se plaint à ce sujet) rm -rf doc, rdoc génère 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 complémentaires)

cour ne fonctionne pas pour moi sur d'autres rubis construit, y compris l'IRM 1.8.7 et JRuby 1.6.4. Il se comporte de la même manière que décrit ci-dessus

+0

Quelle est votre répertoire de travail lorsque vous émettez cette commande? – Phrogz

+0

Le répertoire de travail est le même que celui où se trouvent mes fichiers. C'est la même chose que lorsque j'ai émis la commande tree pour la structure de dossier d'exemple ci-dessus. – wmarbut

+0

Que se passe-t-il lorsque vous essayez d'utiliser rdoc au lieu de triage? Cela aiderait à trianguler si c'est un problème de triage exclusivement, ou un problème de système/configuration. –

Répondre

2

Yard ne documente pas automatiquement tous les fichiers ruby ​​dans une structure de répertoires. Il recherche les fichiers dans un répertoire ./lib. Si vous voulez documenter les autres, vous devez préciser que dans la commande ou dans un fichier .yardopts

exemple yard classes/*.rb *.rb

Questions connexes