問題タブ [rdoc]

Ioke doc では、ISpec テストがドキュメントに含まれています。ioke.org/dok/index.html を参照してください。

これは、Ruby の RSpec と RDoc (または SDoc) でどのように行うことができますか? そのためのコマンドライン スイッチや外部ライブラリが見つかりません。アイデアはありますか（すべて自分で実装することは含まれません;-)）？

私は Apache/passenger でいくつかの rails/rake アプリを実行していgem serverます。これらのアプリに によって提供されるドキュメンテーション アプリを追加したいので、docs.example.org のような特別な (サブ) ドメインを簡単に与えることができます。私たちのチームのすべてのメンバーが簡単に利用でき、誰も自分でサーバーを起動したり、ポート番号 (デフォルトのgem serverポートである 8808 など) を覚えたりする必要はありません。

すべて、rdoc を使用して、C 拡張を含む Ruby コードのドキュメントを生成していますが、メソッドの引数に問題があります。Rdoc はそれらの名前を正しく解析せず、代わりに p1、p2 などを使用します。

まず、拡張機能は実際には C++ としてコンパイルされるため、次のような関数定義を使用する必要があります。

rdoc は、次のような古いスタイルの「C」定義を想定しているようです。

とにかく私はこれを機能させることができますか？

私は、さまざまな言語で何年も使用してきたdoxygenの大ファンです。特に、画像を含め、Graphviz ドット ジェネレーターを実行して、インライン DOT コードまたは外部ファイルから任意のインライン ダイアグラムを作成できる wiki のような機能を高く評価しています。

RDocには、Graphviz を使用してクラス図を生成するためのダイアグラム サポートがありますが、任意の画像や図を含める方法がわかりません。また、酸素のような任意のページの構築もサポートしていないようです。

これらの Doxygen スタイルの機能を Ruby に提供するツールはありますか?

ツールのRuby Toolboxリストをざっと調べたところ、それらはすべてRDocのバリアントのようです。

現時点で私にとって最も可能性の高い解決策は、Yard を拡張することです。

できます

と

どちらも私に良いドキュメントを与えてくれます。

だが

Railsの宝石自体は実際には他の人の単なるホルダーであるため、私にはほとんど何も与えられません。http://api.rubyonrails.org/に相当するものを生成するにはどうすればよいですか？

YARD ドキュメントにいくつかのリンクを作成しようとしています。HTTP リンクを取得できます。

としてレンダリングします

しかし、電子メールのリンク:

私に警告を与える：

そして次のようにレンダリングします

リンクの通常の RDoc 構文を試しました。

しかし、YARDはそれを無視しているようです。より信頼性の高い構文を知っている人はいますか?

gem サーバーを介して Rails のドキュメントをローカルで読みたいと考えています。

私はに行きます

Rails をアンインストールして再インストールしようとしましたが、効果がありませんでした。

他のすべての gem は正常に動作しますが、Rails のドキュメントが表示されないのはなぜですか?

XML形式を使用してRDocを生成しようとしています。これが私が使用しているコマンドです：

ファイルは作成されますが、メソッドリストは生成されません。私はを使用してrdoc (2.4.3)います。XMLのRDocテンプレートには、メソッド表示用のタグが含まれています。

出来ますか？

重複の可能性:
ruby​​ 1.9 riの問題

コマンド プロンプト ウィンドウでRuby のriツールを使用して、クラスやメソッドなどに関するヘルプを取得しようとすると、常に失敗するようです。たとえば、次のように入力すると:

次のようなメッセージが表示されます。

Ruby 1.9.1p243 (2009-07-16 リビジョン 24175) [i386-mingw32] がインストールされた Vista 64 を使用しています。

動作するように構成するにはどうすればよい riですか?