Есть ли способ легко связать файл в RDoc?

Question

Я хочу дать ссылку на документацию файла в RDoc. но единственный способ сделать это с помощью следующей разметки:

configuration.rb[link:files/configuration_rb.html]

Я бы хотел сделать это лучше, примерно так:

<file>configuration.rb</file>

Существует ли какое-либо существующее правило разметки для этого?

РЕДАКТИРОВАТЬ : конечно, я пробовал без какой-либо разметки, подобной этой configuration.rb, но она показывает имя файла без ссылки: (

Answer 1

Для отображения ссылки в rdoc

{Link label}[url ]

Пример

{Killer question}[http:///1684500/est-li-sposob-legko-svyazat-fail-v-rdoc]

создаст ссылку на этот вопрос

Answer 2

Автоматическая гиперссылка: MyClass my_class.rb def my_method; конец; #my_method http :, mailto :, ftp :, www. ссылка: (на локальную файловую систему относительно --op) (ссылки на изображения отображаются как встроенные теги изображений) label [url] (использует пометить как текст гиперссылки) {несколько слов label} [url] (использует label как гиперссылку текст)

Ruby:

ClassNames, source_files.rb и или method_name_having_an_underscore или #methodnamewithhash ссылаются на их документацию.

Звучит так, будто вы ищете второй, но я никогда не использовал его раньше, поэтому не могу привести вам полностью полезный пример.

Answer 3

Старайтесь вообще не использовать разметку.

Посмотрите на собственную документацию RDoc , они имеют похожие ссылки в параграфе "Дорожная карта". Их разметка здесь .

Magic!