Comment générer un RDOC pour (tous) les rails?

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

  •  05-07-2019
  •  | 
  •  

Question

je peux faire 

sudo gem rdoc activerecord --no-ri

et 

sudo gem rdoc actionpack --no-ri

ce qui me donne de bons documents.

Mais 

sudo gem rdoc rails --no-ri

ne me donne pratiquement rien, car le joyau de Rails n’est en réalité qu’un support pour les autres. Comment générer l'équivalent de http://api.rubyonrails.org/ ?

Était-ce utile?

La solution 2

Le plus simple que j'ai trouvé était de les télécharger à partir de railsapi.com et de décompresser le fichier dans / Library. /Ruby/Gems/1.8/doc/rails-2.3.3/rdoc /

Autres conseils

sudo gem rdoc --all --overwrite

Si vous avez installé des rails avec le rdoc (rails d’installation sudo gem) Vous pouvez y accéder via 

gem server

Ci-dessous, je tente de clarifier un peu les étapes relatives à la façon de télécharger localement les documents de la règle 3.1 sur votre machine, comme l’équivalent de http: / /api.rubyonrails.org/

  1. Accédez au projet sdoc à l'adresse https://github.com/voloko/sdoc et obtenez le projet (ou faites simplement gem install sdoc)
  2. Visitez le projet de rails à l'adresse https://github.com/rails/rails et copiez-le sur votre ordinateur local
  3. Allez dans le clone des rails et lancez sdoc -N rails
  4. Cela prendra un moment. Quand cela sera fait, vous aurez un nouveau répertoire appelé doc
  5. Vous pouvez déplacer le répertoire doc n'importe où et ouvrir le fichier index.html dans un navigateur. Notez que vous n'avez pas besoin d'un serveur Web pour que cela fonctionne.

En passant, il semblerait que sdoc soit officiellement devenu la documentation de l'API Ruby on Rails (voir http://weblog.rubyonrails.org/2011/8/29/the-rails-api-switches-to-sdoc )

Vous pouvez geler Rails dans une application et exécuter rake doc: rails pour obtenir les documents. 

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

Les RDocs doivent être situés dans le répertoire doc / api. Vous pouvez utiliser rake rails: freeze: edge pour obtenir de la documentation sur Edge Rails.

Vous pouvez également télécharger les documents depuis un site tel que Rails Brain pour obtenir un modèle de recherche avec lui comme bien.

Si vous souhaitez que les documents apparaissent dans serveur de gemmes , le plus simple est peut-être de réinstaller le gem rails avec l'option rdoc. 

sudo gem install rails --rdoc

Exécutez la commande bundle exec rdoc en ligne de commande.

Il générera toute la documentation de votre code.

Extrait du Projet 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

Si vous devez générer des documents Edge, vous pouvez effectuer quelque chose comme ceci 

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
Licencié sous: CC-BY-SA avec attribution
Non affilié à StackOverflow
scroll top