12


3

RDocでファイルを簡単にリンクする方法はありますか?

RDocのファイルのドキュメントにリンクしたい。 しかし、私ができる唯一の方法は、次のマークアップを使用することです:

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

次のような、より良い方法でそれをしたいと思います:

configuration.rb

これを行うための既存のマークアップルールはありますか?

編集:もちろん、この `configuration.rb`のようなマークアップなしで試しましたが、リンクなしのファイル名が表示されます:(

3 Answer


7


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](ハイパーリンクテキストとしてラベルを使用)

ルビー:

ClassNames、source_files.rb、method_name_having_an_underscoreまたは#methodnamewithhashのいずれかは、ドキュメントにハイパーリンクされています。 _ _

あなたはその2番目のものを探しているように聞こえますが、私は以前にそれを使用したことがないので、完全に有用な例を与えることはできません。


-1


マークアップをまったく使用しないようにしてください。

RDoc独自のドキュメントをご覧ください。「ロードマップ」段落に同様のリンクがあります。 これらのマークアップはhttp://svn.ruby-lang.org/cgi-bin/viewvc.cgi/trunk/lib/rdoc/README?revision=15018&view=markup[here]です。

魔法!