有没有办法轻松链接RDoc中的文件?

时间:2010-02-09 17:09:55

标签: ruby documentation markup rdoc

我想链接到RDoc中的文件文档。但我唯一能做的就是使用以下标记:

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

我想以更好的方式做到这一点,例如:

<file>configuration.rb</file>

是否有任何现有的标记规则可以执行此操作?

编辑:我当然尝试过没有像configuration.rb这样的任何标记,但它显示的文件名没有链接:(

3 个答案:

答案 0 :(得分:7)

在rdoc

中显示链接
{Link label}[url ]

示例

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

将创建此问题的链接

答案 1 :(得分:2)

  

自动超链接:MyClass   my_class.rb def my_method;结束;   #my_method http:,mailto:,ftp:,www。 link :(相对于本地文件系统   --op)(图像的网址呈现为内嵌图像标签)label [url](使用   标签为超链接文本){多字   label} [url](使用label作为超链接   文本)

     

红宝石:

     

ClassNames,source_files.rb和   或   method_name_having_an_underscore或   #methodnamewithhash已超链接到他们的文档。

听起来你正在寻找第二个,但我以前从未使用它,所以我不能给你一个完全有用的例子。

答案 2 :(得分:-1)

尽量不要使用标记。

查看RDoc's own documentation,他们在“路线图”段落中有类似的链接。它们的标记为here

魔术!