Документирование плагинов с помощью RDoc в Rails 3 - PullRequest
0 голосов
/ 26 июля 2011

Я пишу плагин для Rails 3 и использую движки. У меня есть и приложение / папка в моем плагине с контроллером, моделями и представлениями.

Проблема в том, что когда я хочу сгенерировать документацию с помощью RDoc, она не идет в папку app /, чтобы проанализировать находящиеся там файлы. Есть ли вариант, который я должен передать, чтобы он знал, где их искать?

1 Ответ

0 голосов
/ 27 июля 2011

Я в конце концов понял это самостоятельно.Я использовал задачу rake для генерации документации

rake doc:plugins

При этом запускается команда rdoc, но она передает файлы для анализа.В конце концов я справился с этим, используя rdoc прямо в папке с плагинами, вот так:

rdoc -o doc/plugins/my_plugin --title "My plugin Docs" --line-numbers --all --main README
...