Я хотел бы включить информацию о задачах Rake в наше приложение Rails. Мы используем YARD для документации, и на данный момент страницы типа lib/tasks/development.rake отображаются по умолчанию как неформатированный текст.
Я могу сделать их рендерингом как исходный код Ruby с помощью # @markup ruby из документации YARD.
Однако это просто делает любые комментарии встроенными, даже если они включают директивы JARD, такие как # @!method foo. Это означает документацию YARD по маркировке DSL, похоже, не применимо.
Я что-то пропустил?
Как я могу получить YARD для распознавания кода и документации в файлах .rake?
N.B. Я был бы доволен решением, которое игнорирует фактический код и просто генерирует копию документации, но источником для копии документации должен быть сам файл .rake - я не хочу, чтобы документация находилась в отдельном файле .markdown (или независимо), поскольку у них слишком много шансов получить синхронизацию.
Дополнительная информация - команда yard:
Я использую файл .yardopts, содержащий следующее:
--asset graphs 'app/**/*.rb' 'lib/**/*.rb' - README info/*
Чтобы получить YARD для чтения задач Rake, я могу добавить 'lib/tasks/*.rake' после дефиса (т.е. добавить файлы Rake в список файлов YARD), но, как отмечено выше, это не обрабатывает их правильно.
В соответствии с предложением Беньяминса ниже я попытался добавить 'lib/tasks/*.rake' до дефиса (т.е. добавить файлы Rake в список обычных файлов Ruby для обработки), но это, похоже, ничего не генерирует.
Возможно, что YARD генерирует что-то, но не в ожидаемом месте/с ожидаемым именем файла, я полагаю, я не достаточно хорошо разбираюсь в том, как работает YARD, чтобы выяснить, есть ли где-то сиротский выход. В поиске, который генерирует YARD, нет ничего подходящего, и простой find doc | grep rake или find doc | grep basename_of_rake_file ничего не показывает.
