Làm cách nào để tạo RDOC cho (tất cả) Rails?

Question

tôi có thể làm

sudo gem rdoc activerecord --no-ri 

và

sudo gem rdoc actionpack --no-ri 

cả hai đều cho tôi tài liệu tốt.

Nhưng

sudo gem rdoc rails --no-ri 

mang lại cho tôi khá nhiều không có gì, như viên ngọc Rails bản thân thực sự chỉ là một người giữ cho những người khác. Làm thế nào tôi có thể tạo ra tương đương với http://api.rubyonrails.org/?

Answer 1

Các dễ nhất tôi thấy là chỉ cần tải chúng từ railsapi.com và giải nén các tập tin vào /Library/Ruby/Gems/1.8/doc/rails-2.3.3/rdoc/

Answer 2

Từ Rails project 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 

Answer 3

Nếu bạn cài đặt đường ray với rdoc (sudo gem install ray) Bạn có thể truy cập nó qua

gem server 

Answer 4

Nếu bạn cần để tạo tài liệu cạnh, bạn có thể thực hiện một cái gì đó như thế này

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 

Answer 5

Bạn có thể đóng băng Đường ray trong ứng dụng và chạy rake doc:rails để nhận tài liệu.

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

RDocs phải được đặt trong thư mục doc/api. Bạn có thể sử dụng rake rails:freeze:edge để nhận tài liệu về Edge Rails.

Hoặc bạn có thể tải xuống tài liệu từ một trang web như Rails Brain để nhận mẫu có thể tìm kiếm với nó.

Nếu bạn muốn tài liệu hiển thị trong gem server thì điều dễ nhất có thể là cài đặt lại đá quý ray với tùy chọn rdoc.

sudo gem install rails --rdoc 

Answer 6

$ 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 

Answer 7

sudo gem rdoc --all --overwrite 

Answer 8

Dưới đây là nỗ lực của tôi để làm rõ các bước một chút về cách để có được những đường ray 3.1 tài liệu được tải xuống cục bộ vào máy của bạn tương đương với http://api.rubyonrails.org/

1. Chuyển đến sdng projec t ở https://github.com/voloko/sdoc và nhận được dự án (hoặc chỉ cần gem install sdoc)
2. Thăm ray dự án tại https://github.com/rails/rails và git clone nó vào máy tính cục bộ của bạn
3. Đi vào đường ray sao chép và chạy sdoc -N ray
4. này sẽ mất một thời gian. Khi nó được thực hiện, bạn sẽ có một thư mục mới gọi là doc
5. Bạn có thể di chuyển thư mục doc ở bất cứ đâu bạn thích và mở tệp index.html trong trình duyệt. Lưu ý rằng bạn không cần một máy chủ web để làm việc này.

Là một phụ lưu ý nó trông giống như sdoc đã chính thức trở thành tài liệu cho Ruby on Rails API (xem http://weblog.rubyonrails.org/2011/8/29/the-rails-api-switches-to-sdoc)

Answer 9

Run lệnh bundle exec rdoc trên dòng lệnh.

Nó sẽ tạo tất cả tài liệu về mã của bạn.