13


14

できます

sudo gem rdocアクティブレコード--no-ri

そして

sudo gem rdocアクションパック--no-ri

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

しかし

sudo gem rdocレール - のり

Rails gem自体は、他の人にとっては単なる所有者なので、私にはほとんど何も与えません。 どうすればhttp://api.rubyonrails.org/と同等のものを生成できますか?

9 Answer


16


sudo gem rdoc --all --overwrite


14


私が見つけた最も簡単な方法はそれらをhttp://railsapi.com/[railsapi.com]からダウンロードしてファイルを `/ Library / Ruby / Gems / 1.8 / doc / rails-2.3.3 / rdoc /`に解凍することです


9


rdocでレールをインストールした場合(sudo gem install rails)

宝石サーバー


5


以下はhttp://api.rubyonrails.org/と同等の方法でrails 3.1のドキュメントをあなたのマシンにローカルにダウンロードする方法について少しステップを明確にする私の試みです。

  1. https://github.com/voloko/sdocでsdocプロジェクトにアクセスしてプロジェクトを入手してください(または単にgem install sdocを実行してください)。

  2. https://github.com/rails/railsでrailsプロジェクトにアクセスし、それをあなたのローカルマシンにgitクローンしてください。

  3. railsクローンに入り、sdoc -N railsを実行してください。

  4. これにはしばらく時間がかかります。 それが完了すると、docという名前の新しいディレクトリができます。

  5. docディレクトリを好きな場所に移動して、ブラウザでindex.htmlファイルを開くことができます。 これを機能させるためにWebサーバーは必要ありません。

補足として、sdocが正式にRuby on Rails APIのドキュメントになったようです(http://weblog.rubyonrails.org/2011/8/29/the-rails-api-switches-to-sdocを参照)。


3


アプリ内でRailsをフリーズして `rake doc:rails`を実行してドキュメントを取得することができます。

rails doc_project
cd doc_project
rake rails:freeze
rake doc:rails

RDocはdoc / apiディレクトリにあります。 Edge Railsのドキュメントを入手するために `rake rails:freeze:edge`を使うことができます。

あるいは、http://www.railsbrain.com/ [Rails Brain]のようなサイトからドキュメントをダウンロードして、それを使って検索可能なテンプレートを取得することもできます。

ドキュメントを `gem server`に表示したい場合は、最も簡単な方法はrdocオプションを指定してrails gemを再インストールすることです。

sudo gem install rails --rdoc


2


コマンドラインでコマンド `bundle exec rdoc`を実行してください。

それはあなたのコードのすべてのドキュメントを生成します。


0


http://github.com/rails/rails/blob/c4d1075bd366e89a070afd5d6bf859af276c9507/Rakefile[RailsプロジェクトRakefile]から
desc "Railsフレームワーク用のドキュメントを作成する" Rake :: RDocTask.new do | rdoc | rdoc.rdoc_dir = 'doc / rdoc' rdoc.title = "Ruby on Railsのドキュメント"

rdoc.options << '--line-numbers' << '--inline-source' rdoc.options << '-A cattr_accessor = object' rdoc.options << '--charset' << 'utf-8'

rdoc.template = ENV ['template']? "#{ENV ['template']}。rb": './doc/template/horo'

( 'railties / CHANGELOG')rdoc.rdoc_files.include( 'railties / README')rdoc.rdoc_files.include( 'railties / lib / { * .rb、コマンド/ *。rb、rails / *。rb、rails_generator / *。rb} ')

rdoc.rdoc_files.include( 'アクティブレコード/ README')rdoc.rdoc_files.include( 'アクティブレコード/ CHANGELOG')rdoc.rdoc_files.include( 'アクティブレコード/ lib / active_record / ** / *。rb')rdoc.rdoc_files.exclude ( 'activerecord / lib / active_record / vendor / *')

rdoc.rdoc_files.include( 'activeresource / README')rdoc.rdoc_files.include( 'activeresource / CHANGELOG')rdoc.rdoc_files.include( 'activeresource / lib / active_resource.rb')rdoc.rdoc_files.include( 'activeresource / lib) / active_resource / * ')

rdoc.rdoc_files.include( 'actionpack / README')rdoc.rdoc_files.include( 'actionpack / CHANGELOG')rdoc.rdoc_files.include( 'actionpack / lib / action_controller / ** / *。rb')rdoc.rdoc_files.include ( 'actionpack / lib / action_view / ** / *。rb')rdoc.rdoc_files.exclude( 'actionpack / lib / action_controller / vendor / *')

rdoc.rdoc_files.include( 'actionmailer / README')rdoc.rdoc_files.include( 'actionmailer / CHANGELOG') / lib / action_mailer / vendor / * ')

rdoc.rdoc_files.include( 'activesupport / README')rdoc.rdoc_files.include( 'activesupport / CHANGELOG')rdoc.rdoc_files.include( 'アクティブサポート/ lib / active_support / ** / *。rb') ( 'activesupport / lib / active_support / vendor / *')end

#参照イメージをコピーするようにrdocタスクを強化します。タスク: 「終了」


0


あなたがエッジドキュメントを生成する必要があるなら、あなたはこのような何かを実行することができます

git clone git://github.com/rails/rails.git〜/ rails#またはレポをお持ちの場合は、興味のあるブランチをチェックアウトしてください。 vendor / rails rake doc:rerails rake doc:ガイド


0


$ rakeレール:フリーズ:gems $ rakeドキュメント:rails $ rakeレール:unfreeze $ sudo mvドキュメント/ api / * /Library/Ruby/Gems/1.8/doc/rails-2.3.5/rdoc $ gemサーバー