Ruby Yard Doc non mostra alcun file

https://stackoverflow.com//questions/10656142

11-12-2019
|

Domanda

Questa è la mia configurazione:

rubino 1.9.2 P290
yard 0.8.1
La struttura della cartella non è una gemma, solo un vecchio codice rubino semplice:
```
.
├── classes
│   ├── crawl.rb
│   └── page.rb
└── run.rb
```
.
Il problema è che YARD non vede alcun file.
yard doc produce questa uscita:
```
 Files:           0
 Modules:         0 (    0 undocumented)
 Classes:         0 (    0 undocumented)
 Constants:       0 (    0 undocumented)
 Methods:         0 (    0 undocumented)
 0.00% documented
```
.
Qualche idea perché non può vedere nessuno dei miei file o non è
.
Modifica (informazioni aggiuntive):
Yard ha autorizzazioni per creare file.
Dopo aver eseguito il comando yard doc, la mia directory mostra file yard:
```
.       ..      .yardoc classes doc     run.rb
```
.
.
Modifica (risposta al commento su rdoc)
Una volta cancellato la cartella DOC che crea (RDOC lamenta) rm -rf doc, RDoc genera documentazione e fornisce questa uscita
```
 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
```
.
.
Modifica (informazioni aggiuntive)
Yard non funziona per me su altre costruzioni di rubino incluso MRI 1.8.7 e JRUBY 1.6.4.Si comporta allo stesso modo descritto sopra

Soluzione

Yard non documenta automaticamente tutti i file Ruby in una struttura di directory.Cerca file in una directory ./lib.Se si desidera documentare gli altri, è necessario specificare che nel comando o in un file .yardots

Esempio yard classes/*.rb *.rb

Autorizzato sotto: CC-BY-SA insieme a attribuzione

Non affiliato a StackOverflow