問題タブ [rdoc]

作業中のハイパーリンクを使用して、従来の 4 パネルのフレーム付き RDoc 形式を生成したいと考えています。どの RDoc をインストールするかについて何か提案はありますか?

私の ruby​​ 1.8.6 インストールには、4 パネル形式を生成する RDoc がありますが、ファイルはハイパーリンクされていません。Ruby 1.9.2 をインストールすると、フレームなしの Darkfish 形式が生成されますが、これは私が望んでいるものではありません。1.9.2 のインストールに古いバージョンの RDoc をインストールしようとしましたが、なぜか常に Darkfish 形式になります。それを防ぐために使用する必要があるrdocコマンドフラグはありますか?

システムにインストールされている gem の rdoc ドキュメントをすばやく確認する方法として、bdoc (フォーマットにhannaを使用) を使用しています。ただし、gem のインストール時に bundler が rdoc をインストールしないため、新しい gem の使用を開始したり、既存の gem を更新したりするたびに、rdoc を常に手動で生成する必要があります。

手動で行う必要がないように、gem をインストールするときに rdoc をインストールするようにバンドラーを構成する方法があるかどうかは誰にもわかりませんか? これについては、バンドラーのソースにも構成マニュアルにも言及されていません。

Ruby Enterprise をインストールしたばかりで、Ruby Enterprise インストーラーによって呼び出されるこのクラッシュ コマンドの出力ディレクトリを変更できません。

では、この例外を満たすためにディレクトリを削除するにはどうすればよいですか。

RDoc ドキュメントの生成 ./miniruby -I./lib -I.ext/common -I./- -r./ext/purelib.rb ./runruby.rb --extout=.ext -- "./bin/rdoc " --all --ri --op ".ext/rdoc" "."

ディレクトリ .ext/rdoc は既に存在しますが、RDoc ディレクトリではないようです。RDoc は既存のファイルを破壊するリスクを冒したくないため、( --op オプションを使用して) 別の出力ディレクトリ名を指定する必要があります。

flagを使用して gem をインストールしました--no-rdocが、後悔しています。

gem を再インストールしなくても、どうにかして rdoc を生成できますか?

Rake を使用して自分のプロジェクトの RDoc ドキュメントを生成していますが、Darkfish が生成するように見えるグレー オン グレー スタイルが本当に嫌いです。他のすべてに満足しています。配色をもう少し読みやすくしたいと思います。

これが私のレーキタスクです：

上記に追加しようとしまし'--style', 'doc/rdoc.css'たが、不明なオプションであるrd.optionsと不平を言い、無視します。テンプレートやcssなどをカスタマイズする方法に関するドキュメント--styleが見つからないようです。Darkfish が良さそうに見えるものを我慢する必要があるのでしょうか?

これが取引です、

Aptana、Eclipse、またはMicrosoft Expression Webエディターを使用したことがある場合は、組み込みおよびカスタムのオブジェクト、メソッドなどのヒント/情報を示すバルーンテキストまたはIntellisenseポップアップが特徴であることがわかります。

JSDoc、PHPDoc、JavaDoc、RDocなどを通じて情報を取得します。

これらの機能をVimで取得したいのですが、おそらくオムニコンプリートとして実装され、Mac / GVimはバルーンテキストもサポートしているので、これも同様です。

使用する gem はたくさんありますが、切断されることが多く、gem に関するドキュメントをローカルで取得できるようにしたいと考えています。

これまでのところ、私ができることは、実際に gem ライブラリにアクセスして README を見つけることだけです。

web/github にアクセスせずに、ローカルで readme と完全なドキュメントを表示するより良い方法はありますか?

最近興味を持った宝石、ネスタに貢献しようとしています。開発者は、あなたが見つけることができる最も軽量で最も薄いCMSの1つを作成するのに素晴らしい仕事をしました、そして私はそれを文書化したいと思います。私はコードを読み、私の知る限りいくつかの方法についてコメントしました。

gem serverただし、オンラインでプッシュする前に、マシンを呼び出して変更を確認することにより、これをローカルでテストしようとしています。

私が試したこと：

1. 手動編集。
   • ファイルを文書化しました。
   • 起動しましたgem server。
2. gemツール の使用。
   • ファイルを文書化しました。
   • 走ったgem rdoc nesta --rdoc
   • 再起動しましたgem server

すべて無駄に。助けてください。
ありがとうございました。

Ruby 1.9.2p138 で Rdoc 2.58 を使用しています。Darkfish 形式 (これが唯一のオプション) を使用して rdoc ファイルを生成すると、ソース コードのプレビューが表示されません。エラー メッセージは表示されず、すべてのクラスの HTML ファイルが生成されています。

gem を更新してヘルプ ファイルを読んでみましたが、この問題を解決する方法が見つかりません。

これは既知の問題ですか? 他に何を試すことができますか？

アップデート：

コード例:

Rdoc 2.5.8 出力

ソース コードは、生成された rdoc でトグルしません。

Rdoc 3.5.3 の出力

ソース コードは html 出力でトグルします。