Как создать RDOC для (всех) Rails?

Ответ 1

Самый простой способ - просто загрузить их из railsapi.com и распаковать файл в /Library/Ruby/Gems/1.8/doc/rails-2.3.3/rdoc/

Ответ 2

sudo gem rdoc --all --overwrite

Ответ 3

Если вы установили рельсы с rdoc (рельсы установки sudo gem) Вы можете получить доступ к нему через

gem server

Ответ 4

Ниже я попытался немного разъяснить шаги, связанные с тем, как загрузить рельсы 3.1 docs, загруженные локально на ваш компьютер, в качестве эквивалента http://api.rubyonrails.org/

• Перейдите в проект sdoc на https://github.com/voloko/sdoc и получите проект (или просто выполните сборку gem install sdoc)
• Посетите проект rails https://github.com/rails/rails и git, чтобы клонировать его на локальный компьютер.
• Перейдите в клон rails и запустите sdoc -N rails
• Это займет некоторое время. Когда это будет сделано, у вас будет новый каталог с именем doc
• Вы можете переместить каталог doc в любом месте и открыть файл index.html в браузере. Обратите внимание, что для этого вам не нужен веб-сервер.

Как примечание, похоже, что sdoc официально стал документом для API Ruby on Rails (см. http://weblog.rubyonrails.org/2011/8/29/the-rails-api-switches-to-sdoc)

Ответ 5

Вы можете заморозить Rails в приложении и запустить rake doc:rails, чтобы получить документы.

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

RDocs следует располагать в каталоге doc/api. Вы можете использовать rake rails:freeze:edge для получения документации по Edge Rails.

В качестве альтернативы вы можете загрузить документы с сайта, например Rails Brain, чтобы получить шаблон для поиска с ним.

Если вы хотите, чтобы документы отображались в gem server, самым простым может быть переустановка рельсов с помощью опции rdoc.

sudo gem install rails --rdoc

Ответ 6

Запустите команду bundle exec rdoc в командной строке.

Он будет генерировать всю документацию вашего кода.

Ответ 7

Из 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

Ответ 8

Если вам нужно создать пограничные документы, вы можете выполнить что-то вроде этого

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

Ответ 9

$ 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