Wie erzeuge ich RDOC für (alle) Rails?

Question

kann ich

sudo gem rdoc activerecord --no-ri 

und

sudo gem rdoc actionpack --no-ri 

von denen beide geben mir gute docs tun.

Aber

sudo gem rdoc rails --no-ri 

gibt mir ziemlich nichts, da die Rails Juwel selbst wirklich nur ein Halter für die anderen. Wie kann ich das Äquivalent von http://api.rubyonrails.org/ erzeugen?

Answer 1

Die einfachste Ich fand sie einfach herunterladen war von railsapi.com und entpacken Sie die Datei in /Library/Ruby/Gems/1.8/doc/rails-2.3.3/rdoc/

Answer 2

Vom 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

Wenn Sie Schienen mit dem rdoc (sudo gem install Schienen) installiert Sie können darauf zugreifen über

gem server 

Answer 4

Wenn Sie Rand docs generieren müssen, können Sie Führen Sie so etwas aus

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

Sie können einfrieren Rails in einer App und führen rake doc:rails, um die Dokumentation zu erhalten.

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

Die RDocs sollten sich im doc/api-Verzeichnis befinden. Sie können rake rails:freeze:edge verwenden, um Dokumentation für Edge Rails zu erhalten.

Alternativ können Sie die Dokumente von einer Website wie Rails Brain herunterladen, um eine durchsuchbare Vorlage zu erhalten.

Wenn Sie möchten, dass die Dokumente in gem server angezeigt werden, dann ist die einfachste Sache vielleicht, die Rails Gem mit der Rdoc-Option neu zu installieren.

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

Unten ist mein Versuch, die Schritte ein wenig auf zu klären, wie die Schienen zu bekommen 3.1 Dokumente heruntergeladen lokal auf Ihrem Computer als Äquivalent von http://api.rubyonrails.org/

1. Gehen Sie zum Sdoc-Projekt t bei https://github.com/voloko/sdoc und bekommen das Projekt (oder einfach nicht gem install SDoC)
2. Besuchen Sie die Schienen-Projekt bei https://github.com/rails/rails und git clone es auf den lokalen Rechner
3. Gehen Sie in die Schienen klonen und laufen SDoC N Schienen
4. Diese wird eine Weile dauern. Wenn Sie fertig sind, haben Sie ein neues Verzeichnis namens doc
5. Sie können das doc-Verzeichnis beliebig verschieben und die Datei index.html in einem Browser öffnen. Beachten Sie, dass Sie dafür keinen Webserver benötigen.

Als Seite beachten Sie, es sieht aus wie SDoC offiziell die Dokumentation für die Ruby on Rails API geworden ist (siehe http://weblog.rubyonrails.org/2011/8/29/the-rails-api-switches-to-sdoc)

Answer 9

Führen Sie den Befehl bundle exec rdoc auf der Kommandozeile.

Es wird die gesamte Dokumentation Ihres Codes generieren.