¿Cómo genero RDOC para (todos) Rails?

StackOverflow https://stackoverflow.com/questions/1202060

  •  05-07-2019
  •  | 
  •  

Pregunta

Puedo hacer 

sudo gem rdoc activerecord --no-ri

y 

sudo gem rdoc actionpack --no-ri

ambos me dan buenos documentos.

Pero 

sudo gem rdoc rails --no-ri

no me da prácticamente nada, ya que la gema Rails en sí misma es realmente un soporte para los demás. ¿Cómo puedo generar el equivalente de http://api.rubyonrails.org/ ?

¿Fue útil?

Solución 2

Lo 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/

Otros consejos

sudo gem rdoc --all --overwrite

Si instaló rieles con el rdoc (sudo gem install install rails) Puedes acceder a ella a través de 

gem server

A continuación se muestra mi intento de aclarar los pasos un poco sobre cómo descargar los documentos de Rails 3.1 localmente en su máquina como el equivalente de http: / /api.rubyonrails.org/

  1. Vaya al proyecto sdoc en https://github.com/voloko/sdoc y obtenga el proyecto (o simplemente haga gema instalar sdoc)
  2. Visite el proyecto de los rieles en https://github.com/rails/rails y git clone en su máquina local
  3. Vaya a la clonación de rieles y ejecute sdoc -N rails
  4. Esto tomará un tiempo. Cuando haya terminado, tendrá un nuevo directorio llamado doc
  5. Puede mover el directorio doc a cualquier lugar que desee 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, parece que sdoc se ha convertido oficialmente en la documentación de la API de Ruby on Rails (consulte http://weblog.rubyonrails.org/2011/8/29/the-rails-api-switches-to-sdoc )

Puedes congelar Rails en una aplicación y ejecutar rake doc: rails para obtener los documentos. 

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

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

Alternativamente, puede descargar los documentos desde un sitio como Rails Brain para obtener una plantilla de búsqueda con ella como bien.

Si desea que los documentos se muestren 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

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

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

De la 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

Si necesita generar documentos de borde, puede realizar 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

$ 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
Licenciado bajo: CC-BY-SA con atribución
No afiliado a StackOverflow
scroll top