有什么方法可以轻松链接 RDoc 中的文件吗?

发布于 2024-08-20 10:31:15 字数 336 浏览 7 评论 0原文

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

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

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

<file>configuration.rb</file>

是否有任何现有的标记规则可以做到这一点?

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

I want to link to a documentation of a file in RDoc. but the only way I could do is with the following markup:

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

I would like to do it in a better way, something like this:

<file>configuration.rb</file>

Is there any existing markup rule to do this?

EDIT: of course I've tried without any markup like this configuration.rb but it shows the filename without the link :(

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。

评论(3

他是夢罘是命 2024-08-27 10:31:15

中显示链接,

{Link label}[url ]

要在 rdoc示例

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

将创建此问题的链接

To display a link in rdoc

{Link label}[url ]

Sample

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

will create a link of the this question

叹倦 2024-08-27 10:31:15

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

红宝石:

类名、source_files.rb 和
任何一个
method_name_having_an_下划线或
#methodnamewithhash 超链接到他们的文档。

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

Auto hyperlinked: MyClass
my_class.rb def my_method; end;
#my_method http:, mailto:, ftp:, www. link: (to local filesystem relative to
--op) (urls to images are rendered as inline image tags) label[url] (uses
label as hyperlink text) {multi word
label}[url] (uses label as hyperlink
text)

Ruby:

ClassNames, source_files.rb and
either
method_name_having_an_underscore or
#methodnamewithhash are hyperlinked to their documentation.

It sounds like you're looking for that second one, but I've never used it before so I can't give you a fully useful example.

怀中猫帐中妖 2024-08-27 10:31:15

尽量不要使用标记。

看看RDoc自己的文档,他们在“Roadmap”段落中有类似的链接。他们的标记是 这里

魔法!

Try not to use markup at all.

Look at RDoc's own documentation, they have similar links in the "Roadmap" paragraph. They markup is here.

Magic!

~没有更多了~
我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
原文