RDoc предназначен для синтаксического анализа исходного файла, просмотра комментариев и их местоположения, создания перекрестных ссылок на переменные и, когда это будет сделано, связывания всего этого в приличный вывод.Поскольку RDoc предназначен для работы с исходными файлами, он может оказаться не лучшим выбором для того, что вы хотите сделать.
Вместо этого вы можете захотеть взглянуть на Двор , основанный на тегах. Могу ли я вставить свой README.textile в мой RDoc с правильным форматированием? также содержит некоторую полезную информацию для вас.
В любом случае, если вы не можете заставить приложение анализировать READMEТип документа, как вы хотите, вы могли бы подделать его, поместив все свои документы в файл вместе с заглушками классов и методов, чтобы анализаторы могли получить параметры, глобальные переменные и другие "что-то еще" им нужно для создания полезной документации.
В противном случае вам, вероятно, придется отказаться от использования автоматизированной справки и ввести все это.
Я рекомендую сделать это способом RDoc и документировать его внутри кода.Это совсем не сложно, и результат может быть очень удовлетворительным.Удивительно, как хорошо справляется с работой RDoc.