(모든) 레일에 대한 RDOC를 어떻게 생성합니까?

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

  •  05-07-2019
  •  | 
  •  

문제

내가 할 수있는

sudo gem rdoc activerecord --no-ri

그리고 

sudo gem rdoc actionpack --no-ri

둘 다 좋은 문서를 제공합니다.

하지만

sudo gem rdoc rails --no-ri

레일 보석 자체가 실제로 다른 사람들을위한 홀더 일뿐 때문에 거의 아무것도주지 않습니다. 동등한 것을 어떻게 생성 할 수 있습니까? http://api.rubyonrails.org/?

도움이 되었습니까?

해결책 2

내가 찾은 가장 쉬운 것은 그냥 다운로드하는 것이 었습니다. Railsapi.com 파일을 풀어주십시오 /Library/Ruby/Gems/1.8/doc/rails-2.3.3/rdoc/

다른 팁

sudo gem rdoc --all --overwrite

RDOC (Sudo Gem Install Rails)와 함께 레일을 설치 한 경우 

gem server

아래는 레일 3.1 문서를 기계에 로컬로 다운로드하는 방법에 대한 단계를 명확히하려는 시도입니다. http://api.rubyonrails.org/

  1. SDOC 프로젝트로 이동하십시오 https://github.com/voloko/sdoc 프로젝트를 받으십시오 (또는 GEM을 설치하여 SDOC를 설치하십시오)
  2. Rails 프로젝트를 방문하십시오 https://github.com/rails/rails 그리고 git는 그것을 로컬 기계로 복제합니다
  3. 레일 클론으로 가서 SDOC -N 레일을 실행하십시오.
  4. 시간이 걸릴 것입니다. 완료되면 Doc이라는 새 디렉토리가 있습니다.
  5. 원하는 곳 어디서 Doc 디렉토리를 이동하고 브라우저에서 index.html 파일을 열 수 있습니다. 작동하려면 웹 서버가 필요하지 않습니다.

부수적으로 SDOC가 공식적으로 Ruby on Rails API의 문서가 된 것처럼 보입니다 ( http://weblog.rubyonrails.org/2011/8/29/the-rails-api-switches-to-sdoc)

앱에서 레일을 동결하고 실행할 수 있습니다 rake doc:rails 문서를 얻으려면.

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

RDOC는 DOC/API 디렉토리에 있어야합니다. 당신이 사용할 수있는 rake rails:freeze:edge Edge Rails에 대한 문서를 얻으려면.

또는 같은 사이트에서 문서를 다운로드 할 수 있습니다. Rails Brain 검색 가능한 템플릿을 얻으려면.

문서가 나타나기를 원한다면 gem server 그런 다음 가장 쉬운 것은 RDOC 옵션으로 레일 보석을 다시 설치하는 것입니다.

sudo gem install rails --rdoc

명령을 실행하십시오 bundle exec rdoc 명령 줄.

코드의 모든 문서를 생성합니다.

로부터 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

에지 문서를 생성 해야하는 경우 이와 같은 것을 수행 할 수 있습니다.

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
라이센스 : CC-BY-SA ~와 함께 속성
제휴하지 않습니다 StackOverflow
scroll top