Ruby-Yard-Dokument zeigt keine Dateien an
Frage
Das ist mein Setup:
- Ruby 1.9.2 S. 290
- Hof 0.8.1
Die Ordnerstruktur ist kein Juwel, sondern einfach nur alter Ruby-Code:
.
├── classes
│ ├── crawl.rb
│ └── page.rb
└── run.rb
Das Problem ist, dass Yard keine Dateien sieht.
yard doc
ergibt diese Ausgabe:
Files: 0
Modules: 0 ( 0 undocumented)
Classes: 0 ( 0 undocumented)
Constants: 0 ( 0 undocumented)
Methods: 0 ( 0 undocumented)
0.00% documented
Irgendwelche Ideen, warum keine meiner Dateien angezeigt werden kann oder nicht
Bearbeiten (zusätzliche Informationen):
Yard verfügt über Berechtigungen zum Erstellen von Dateien.
Nachdem ich das ausgeführt habe yard doc
Befehl, mein Verzeichnis zeigt Yard-Dateien:
. .. .yardoc classes doc run.rb
Bearbeiten (Antwort auf Kommentar zu rdoc)
Sobald ich den von Yard erstellten Dokumentordner lösche (rdoc beschwert sich darüber) rm -rf doc
, rdoc generiert die Dokumentation und stellt diese Ausgabe bereit
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
Bearbeiten (Zusätzliche Informationen)
Yard funktioniert bei mir nicht auf anderen Ruby-Builds, einschließlich MRI 1.8.7 und jRuby 1.6.4.Es verhält sich genauso wie oben beschrieben
Lösung
Yard dokumentiert nicht automatisch alle Ruby-Dateien in einer Verzeichnisstruktur.Es sucht nach Dateien in a ./lib
Verzeichnis.Wenn Sie andere dokumentieren möchten, müssen Sie dies im Befehl oder in einer .yardopts-Datei angeben
Beispielyard classes/*.rb *.rb