Como faço para gerar RDOC para (todos) trilhos?

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

  •  05-07-2019
  •  | 
  •  

Pergunta

eu posso fazer

sudo gem rdoc activerecord --no-ri

e 

sudo gem rdoc actionpack --no-ri

ambos me dão bons documentos.

Mas

sudo gem rdoc rails --no-ri

Não me dá praticamente nada, pois a jóia do Rails em si é realmente apenas um titular para os outros. Como posso gerar o equivalente a http://api.rubyonrails.org/?

Foi útil?

Solução 2

O mais fácil que encontrei foi apenas baixá -los de Railsapi.com e descompacte o arquivo em /Library/Ruby/Gems/1.8/doc/rails-2.3.3/rdoc/

Outras dicas

sudo gem rdoc --all --overwrite

Se você instalou trilhos com o RDOC (Sudo Gem Install Rails), poderá acessá -lo via 

gem server

Abaixo está minha tentativa de esclarecer um pouco as etapas sobre como obter o Rails 3.1 documentos baixados localmente para sua máquina como equivalente a http://api.rubyonrails.org/

  1. Vá para o projeto SDOC em https://github.com/voloko/sdoc e obtenha o projeto (ou apenas faça o Gem Install SDOC)
  2. Visite o projeto Rails em https://github.com/rails/rails e git clone para sua máquina local
  3. Entre no clone dos trilhos e corra SDOC -N Rails
  4. Isso vai demorar um pouco. Quando estiver pronto, você terá um novo diretório chamado Doc
  5. Você pode mover o diretório do documento para qualquer lugar que quiser e abrir o arquivo index.html em um navegador. Observe que você não precisa de um servidor da Web para que isso funcione.

Como uma nota lateral, parece que o SDOC se tornou oficialmente os documentos da API Ruby on Rails (ver http://weblog.rubyonrails.org/2011/8/29/the-rails-api-switches-to-sdoc)

Você pode congelar trilhos em um aplicativo e executar rake doc:rails para obter os documentos.

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

Os RDOCs devem estar localizados no diretório DOC/API. Você pode usar rake rails:freeze:edge Para obter documentação para trilhos de borda.

Como alternativa, você pode baixar os documentos de um site como Trilhos do cérebro Para obter um modelo pesquisável com ele também.

Se você deseja que os documentos apareçam gem server Então, a coisa mais fácil pode ser reinstalar a jóia do Rails com a opção RDOC.

sudo gem install rails --rdoc

Execute o comando bundle exec rdoc na linha de comando.

Ele gerará toda a documentação do seu código.

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

Se você precisar gerar documentos de borda, pode executar algo assim

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 em: CC-BY-SA com atribuição
Não afiliado a StackOverflow
scroll top