13

できます

sudo gem rdoc activerecord --no-ri

と

sudo gem rdoc actionpack --no-ri

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

だが

sudo gem rdoc rails --no-ri

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

4

9 に答える 9

16 
sudo gem rdoc --all --overwrite
于 2011-03-25T17:57:12.737 に答える
15

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

于 2009-08-04T17:52:19.827 に答える
9

rdoc (sudo gem install rails) を使用してレールをインストールした場合は、次の方法でアクセスできます。

gem server
于 2009-07-29T21:57:32.703 に答える
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 clone します。
  3. rails clone に入り、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を参照) 。

于 2011-09-18T17:26:13.993 に答える
2

bundle exec rdocコマンドラインでコマンドを実行します。

コードのすべてのドキュメントが生成されます。

于 2012-09-09T14:17:51.633 に答える
0

Rails プロジェクトの Rakefileから

desc "Generate documentation for the Rails framework"
Rake::RDocTask.new do |rdoc|
  rdoc.rdoc_dir = 'doc/rdoc'
  rdoc.title = "Ruby on Rails Documentation"

  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'

  rdoc.rdoc_files.include('railties/CHANGELOG')
  rdoc.rdoc_files.include('railties/MIT-LICENSE')
  rdoc.rdoc_files.include('railties/README')
  rdoc.rdoc_files.include('railties/lib/{*.rb,commands/*.rb,rails/*.rb,rails_generator/*.rb}')

  rdoc.rdoc_files.include('activerecord/README')
  rdoc.rdoc_files.include('activerecord/CHANGELOG')
  rdoc.rdoc_files.include('activerecord/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')
  rdoc.rdoc_files.include('actionmailer/lib/action_mailer/base.rb')
  rdoc.rdoc_files.exclude('actionmailer/lib/action_mailer/vendor/*')

  rdoc.rdoc_files.include('activesupport/README')
  rdoc.rdoc_files.include('activesupport/CHANGELOG')
  rdoc.rdoc_files.include('activesupport/lib/active_support/**/*.rb')
  rdoc.rdoc_files.exclude('activesupport/lib/active_support/vendor/*')
end

# Enhance rdoc task to copy referenced images also
task :rdoc do
  FileUtils.mkdir_p "doc/rdoc/files/examples/"
  FileUtils.copy "activerecord/examples/associations.png", "doc/rdoc/files/examples/associations.png"
end
于 2009-07-29T18:27:47.343 に答える
0 
$ rake rails:freeze:gems
$ rake doc:rails
$ rake rails:unfreeze
$ sudo mv doc/api/* /Library/Ruby/Gems/1.8/doc/rails-2.3.5/rdoc
$ gem server
于 2010-02-06T18:41:31.067 に答える
0

エッジ ドキュメントを生成する必要がある場合は、次のような操作を実行できます。

git clone git://github.com/rails/rails.git ~/rails
# or if you have repo, just checkout interested branch
cd ~
ruby ~/rails/railties/bin/rails docapp
cd docapp
ln -s ~/rails vendor/rails
rake doc:rerails
rake doc:guides
于 2009-08-04T11:54:52.467 に答える