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

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

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

Я хотел бы сделать это лучше, что-то вроде этого:

<file>configuration.rb</file>

Существует ли существующее правило разметки?

EDIT: конечно, я пробовал без какой-либо разметки вроде configuration.rb, но он показывает имя файла без ссылки: (

Ответ 1

Чтобы отобразить ссылку в rdoc

{Link label}[url ]

Пример

{Killer question}[http://http://stackoverflow.com/questions/2230954/is-there-any-way-to-easily-link-a-file-in-rdoc]

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

Ответ 2

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

Ruby:

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

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

Ответ 3

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

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

Магия!