¿Cómo puedo generar RDOC para (todos) Rails?

Question

que puedo hacer

sudo gem rdoc activerecord --no-ri 

y

sudo gem rdoc actionpack --no-ri 

ambos de los cuales me dan buenos doctores.

Pero

sudo gem rdoc rails --no-ri 

me da casi nada, como la propia gema Rails es realmente sólo un soporte para los demás. ¿Cómo puedo generar el equivalente de http://api.rubyonrails.org/?

Answer 1

La forma más fácil que encontré fue simplemente descargarlos de railsapi.com y descomprimir el archivo en /Library/Ruby/Gems/1.8/doc/rails-2.3.3/rdoc/

Answer 2

Desde el 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

Si ha instalado carriles con el rdoc (sudo gem instalar rieles) Puede acceder a ella a través de

gem server 

Answer 4

Si necesita generar documentos de última generación, que pueda realice algo como esto

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

Puede congelar Rieles en una aplicación y ejecute rake doc:rails para obtener los documentos.

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

Los RDocs se deben ubicar en el directorio doc/api. Puede usar rake rails:freeze:edge para obtener documentación para Edge Rails.

También puede descargar los documentos de un sitio como Rails Brain para obtener también una plantilla de búsqueda.

Si desea que los documentos aparezcan en gem server, lo más fácil puede ser volver a instalar la gema de rieles con la opció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

A continuación se muestra mi intento de clarificar los pasos un poco sobre cómo conseguir los rieles 3.1 documentos descargados localmente en su equipo como el equivalente de http://api.rubyonrails.org/

1. Ir al proyecto sdoc t en https://github.com/voloko/sdoc y obtener el proyecto (o simplemente instalar la gema DCP)
2. Visita el proyecto carriles en https://github.com/rails/rails y git clone a su máquina local
3. entrar en los carriles de clonar y correr la DCP -N rieles
4. Este tomará un tiempo Cuando esté listo, tendrá un nuevo directorio llamado doc
5. Puede mover el directorio doc a cualquier lugar y abrir el archivo index.html en un navegador. Tenga en cuenta que no necesita un servidor web para que esto funcione.

Como nota al margen que parece que la DCP ha convertido oficialmente en la documentación para la API de Ruby on Rails (ver http://weblog.rubyonrails.org/2011/8/29/the-rails-api-switches-to-sdoc)

Answer 9

Ejecutar el comando bundle exec rdoc en la línea de comandos.

Generará toda la documentación de su código.