2012-05-18 4 views
2

Это моя установка:Рубин двор документ не показывает каких-либо файлов

  • Руби 1.9.2 P290
  • Yard 0.8.1

Структура папки не драгоценный камень, просто старый Код Ruby:

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

Проблема заключается в том, что на дворе нет файлов.

yard doc дает этот выход:

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

Любые идеи, почему он не может видеть любой из моих файлов, или не


Edit (Дополнительная информация):

У Yard есть разрешения на создание файлов.

После того как я запустить команду yard doc, мой каталог показывает двор файлы:

.  ..  .yardoc classes doc  run.rb 

Edit (ответ на комментарий о RDoc)

Как только я удалить папку DOC, который создает двор (RDoc жалуется на это) rm -rf doc, rdoc создает документацию и предоставляет этот выход

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 

Edit (Дополнительная информация)

двор не работает для меня на другой рубин строит включая МРТ 1.8.7 и JRuby 1.6.4. Он ведет себя так же, как описано выше.

+0

Что ваш рабочий каталог, когда вы выдаете эту команду? – Phrogz

+0

Рабочий каталог такой же, как и в моих файлах. Это то же самое, что и при выдаче команды tree для структуры вышеприведенных папок. – wmarbut

+0

Что происходит, когда вы пытаетесь использовать rdoc вместо двора? Это помогло бы триангулировать, будь то проблема с ядром или проблема с системой/конфигурацией. –

ответ

2

Двор не автоматически документирует все рубиновые файлы в структуре каталогов. Он ищет файлы в каталоге ./lib. Если вы хотите, чтобы документ другим, вы должны указать, что в команде или в .yardopts файл

пример yard classes/*.rb *.rb