問題タブ [rdoc]
For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.
ruby-on-rails - rdocgemをフェッチするときのサーバーエラー500
LionにアップグレードされたMacでバンドルアップデートを実行しようとしています。
次のエラーで、常にrdocのフェッチに失敗しています。
これは私が修正できるものである可能性が高いですか、それとも私がそれ自体を明確に見ることが期待できるrubygemsまたはrdocの問題ですか?
他のgemは正しくダウンロードおよびインストールされています。Gemfileでrdocを直接呼び出すことはありませんが、特定の(より低い)バージョンでrdocを追加しようとしましたが、同じエラーが発生します。からも同じエラーが発生しますgem install rdoc
。
これが私のgemfileの内容です:
Rails 3.1.0.rc1、rc2、またはrc3を使用すれば、すべて問題ありません。しかし、スプロケットに問題があるようです(ここで参照)。Rails3.1.0rc5に移動することをお勧めします。それを(そしてrc4で)行おうとすると、rdocのフェッチに問題が発生します。rails 3.1.0rc5の代わりに、以前のリリースのスプロケットを使用することもできますが、私もそれがうまくいきませんでした。
ruby - RDoc を LaTeX に生成する
LaTeX 形式で RDoc を生成することは可能ですか? RDoc と YARD を見ましたが、必要なものが見つかりませんでした。
Ruby のプロジェクトのドキュメントを LaTeX で書いていますが、API リファレンスを付録または章として、最終的な PDF に簡単に埋め込む方法が必要です。私にとって最も便利な方法は、Ruby ソース ファイルから LaTeX ソースを生成し、適切な場所にインクルードすることです。
ruby - gem サーバーの実行時に ruby コアと標準ドキュメントを表示する
実行時に ruby コアと標準ライブラリのドキュメントを表示する方法はありgem server
ますか?
rvm で作成されたコアおよび標準ドキュメントをナビゲートできますが、すべてのドキュメントを 1 か所にまとめたいと考えています。
を実行しましrvm docs [generate|generate-ri|generate-rdoc]
たが、これらのコマンドのいずれも rubygems にドキュメントを追加しませんでした。
ruby-on-rails - 指定されたモジュールが見つかりませんでした(MySQL)
Windowsで次のエラーが発生した場合の対処方法:
UPDATE2:Mysql サーバー5.5を使用しています。Libmqlファイルが/ libディレクトリーにあるので、そのファイルをruby/binとruby/libに貼り付けました。そしてcmdで私は同じ上記のエラーを受け取りました。
UPDATE1:これを再度実行すると、次のようになります。
C:\ work \ exchange2> geminstallmysql正常にインストールされたmysql-2.8.1-x86-mingw321gemがインストールされましたmysql-2.8.1-x86-mingw32のriドキュメントをインストールしています...
next_resultの定義がありません
field_nameの定義がありません
field_tableの定義がありません
field_defの定義がありません
field_typeの定義はありません
field_lengthの定義はありません
field_max_lengthの定義がありません
field_flagsの定義はありません
field_decimalsの定義はありません
time_inspectの定義はありません
time_to_sの定義はありません
time_get_yearの定義はありません
time_get_monthの定義はありません
time_get_dayの定義はありません
time_get_hourの定義はありません
time_get_minuteの定義はありません
time_get_secondの定義はありません
time_get_negの定義はありません
time_get_second_partの定義はありません
time_set_yearの定義はありません
time_set_monthの定義はありません
time_set_dayの定義はありません
time_set_hourの定義はありません
time_set_minuteの定義はありません
time_set_secondの定義はありません
time_set_negの定義はありません
time_set_second_partの定義はありません
time_equalの定義はありません
error_errnoの定義がありません
error_sqlstateの定義がありませんmysql-2.8.1-x86-mingw32のRDocドキュメントをインストールしています...
next_resultの定義がありません
field_nameの定義がありません
field_tableの定義がありません
field_defの定義がありません
field_typeの定義はありません
field_lengthの定義はありません
field_max_lengthの定義がありません
field_flagsの定義はありません
field_decimalsの定義はありません
time_inspectの定義はありません
time_to_sの定義はありません
time_get_yearの定義はありません
time_get_monthの定義はありません
time_get_dayの定義はありません
time_get_hourの定義はありません
time_get_minuteの定義はありません
time_get_secondの定義はありません
time_get_negの定義はありません
time_get_second_partの定義はありません
time_set_yearの定義はありません
time_set_monthの定義はありません
time_set_dayの定義はありません
time_set_hourの定義はありません
time_set_minuteの定義はありません
time_set_secondの定義はありません
time_set_negの定義はありません
time_set_second_partの定義はありません
time_equalの定義はありません
error_errnoの定義がありません
error_sqlstateの定義がありません
ruby-on-rails - Rails でのモデル スコープのドキュメントの追加
これが実際に可能かどうかはわかりませんが、app/models
ファイルにスコープのドキュメントを追加することで、Rails アプリのドキュメントをより完全なものにしようとしています。私がしようとしていることは次のとおりです。
そして、アプリで rdoc を実行すると、次のように文書化されるより伝統的なメソッドとともに、パブリック クラス メソッドとしてリストされていることを確認したいと思います。newest_records
編集
この質問は少し曖昧かもしれません。したがって、ここで明確にする試みがあります。現在、宣言の上にコメント行を追加しようとするとscope
、RDoc によって生成されたスコープのドキュメントは取得されません。RDocがメタメソッド/属性を取得できることは知っています。そうしないと、で宣言されたドキュメントに属性が表示されませんattr_accessor
。だから私の質問は、次のようにファイルにコメントを追加する方法です:
- このメソッドは、RDoc で生成されたドキュメントに表示されます
- パブリッククラスメソッドとして表示されます(パブリックインスタンスメソッドなどとは対照的に)
ruby-on-rails - Rails アプリの Rdoc を作成する
Rails (2.3.8) プロジェクトのドキュメントを生成したいと考えています。私が試したとき
標準の ruby クラスを含むすべてのクラスと vendor ディレクトリ内のすべての ruby ファイル (プラグインなど) のドキュメントを作成します。
次のディレクトリにあるルビークラス、ファイルのみのrdocドキュメントを作成するにはどうすればよいですか
- app フォルダー (すべてのモデル、コントローラー、およびビュー)
- 構成フォルダー
- lib フォルダー
ruby-on-rails - ロードするそのようなファイルはありません--rdoc/task
私が走るとき
このエラーが発生します
これが--traceです
rake0.9.2とrdoc3.11をインストールしています。これらのコマンドをアプリのディレクトリで実行しています。
ruby - RDocマークアップを使用して逐語的/コード/事前プラス記号をレンダリングするにはどうすればよいですか?
RDocマークアップを使用し、Yardでドキュメントを生成して、次のような行を持つコマンド出力を文書化しようとしています。
...しかし、これを達成する方法を理解することはできません。どうすればHTMLになりますか?
私はドキュメントで些細なことを見逃したと確信しています...
#1を試す
マークアップをエスケープしようとせずに、この2つのスペースをインデントします(他のコード/プレブロックと同様)。
...ドキュメントを生成し、HTMLを取得します(予想どおり、私は推測します):
#2を試す
バックスラッシュを使用してエスケープする場合、このマークアップは次のとおりです。
...このHTMLになります:
#3を試す
奇妙なことに、2つのプラス記号を連続して使用すると、このマークアップは次のようになります。
...このHTMLになります:
#4をお試しください
インデントなしを使用<tt>
すると、「逐語的」ではない(つまり、pre / code)セクションが残ります。単なるプレーンテキスト(ここでも、予想どおり、私は推測します):
...このHTMLになります:
#5をお試しください
インデントを使用する<tt>
と、このマークアップが変わります。
...このHTMLに:
ruby - RDoc にローカル イメージを含める
rdoc ドキュメントの最初のページに含めたい "ビジュアル" ツールでイメージを作成しました。フロントページは *.rdoc で定義されています。外部の画像を含めることは可能ですが、ローカルの画像を含めるにはどうすればよいですか?
更新: 回避策は、二重引用符なしで画像の html を追加することです:<img src=../../images/overview.jpg>
画像がルート ディレクトリの画像フォルダーにある場合。(同じフォルダ内のいくつかのフォルダに rdoc を生成すると仮定します。) 適切な/>
エンディングも機能しません。/
が URL に追加されます。
ruby - RDoc::ClassModule#description のカスタマイズ
RDoc 用の新しいジェネレーターを作成しようとしていますが、オブジェクトのdescription
出力をカスタマイズする方法がわかりません。RDoc::ClassModule
現在、次のようになっています。
「Gist」のリンクをカスタマイズして#!/search/Octopi::Gist
、Gist
.
どうすればこれを行うことができますか?