O documento Ruby Yard não mostra nenhum arquivo
Pergunta
Esta é a minha configuração:
- Rubi 1.9.2 p290
- Quintal 0.8.1
A estrutura de pastas não é uma joia, apenas um código Ruby antigo:
.
├── classes
│ ├── crawl.rb
│ └── page.rb
└── run.rb
O problema é que o quintal não vê nenhum arquivo.
yard doc
produz esta saída:
Files: 0
Modules: 0 ( 0 undocumented)
Classes: 0 ( 0 undocumented)
Constants: 0 ( 0 undocumented)
Methods: 0 ( 0 undocumented)
0.00% documented
Alguma idéia de por que ele não consegue ver nenhum dos meus arquivos ou não
Editar (informações adicionais):
Yard tem permissões para criar arquivos.
Depois de executar o yard doc
comando, meu diretório mostra arquivos de quintal:
. .. .yardoc classes doc run.rb
Editar (resposta ao comentário sobre rdoc)
Depois de excluir a pasta de documentos que o quintal cria (rdoc reclama disso) rm -rf doc
, rdoc gera documentação e fornece esta saída
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
Editar (informações adicionais)
Yard não funciona para mim em outras compilações Ruby, incluindo MRI 1.8.7 e jRuby 1.6.4.Ele se comporta da mesma maneira descrita acima
Solução
O Yard não documenta automaticamente todos os arquivos Ruby em uma estrutura de diretórios.Ele procura arquivos em um ./lib
diretório.Se quiser documentar outros, você deve especificar isso no comando ou em um arquivo .yardopts
exemployard classes/*.rb *.rb