Подсветка синтаксиса кода Ruby в файле RDoc?

Question

Я документирую библиотеку Ruby, которую я пишу. В мой файл README.rdoc я включил пример использования с некоторым демонстрационным кодом Ruby.

Однако итоговая документация HTML не показывает код Ruby с подсветкой синтаксиса, а просто как блок кода.

Когда я смотрю на источник, например, http://rdoc.rubyforge.org/README_rdoc.html, все, что я вижу, это кусочек кода Ruby, как я включил в свой README.rdoc. Есть ли специальная опция для передачи в команду rdoc?

Answer 1

Вы должны использовать шаблон RDoc, который включает подсветку синтаксиса. Есть много плавающих в сети.

(Я согласен с Phrogz, вы должны использовать YARD, а также синтаксис Markdown.)

Answer 2

RDoc, несколько наивно, использует метод ниже, чтобы определить, может ли он использовать подсветку синтаксиса.

   def parseable? text
     text =~ /\b(def|class|module|require) |=>|\{\s?\||do \|/ and
       text !~ /<%|%>/
   end

Таким образом, ваш код будет выделен только в том случае, если он содержит одну из следующих строк:

• Защита
• учебный класс
• модуль
• требовать
• =>
• {|
• делать |