كيف أقوم بإنشاء RDOC لـ (كل) القضبان؟

Question

أستطيع أن أفعل

sudo gem rdoc activerecord --no-ri

و

sudo gem rdoc actionpack --no-ri

كلاهما يعطيني مستندات جيدة.

ولكن

sudo gem rdoc rails --no-ri

لا يعطيني شيئًا إلى حد كبير ، لأن جوهرة القضبان نفسها هي في الحقيقة مجرد حامل للآخرين. كيف يمكنني توليد ما يعادل http://api.rubyonrails.org/?

Answer 1

أسهل وجدته هو فقط تنزيلها من Railsapi.com وتفريغ الملف في /Library/Ruby/Gems/1.8/doc/rails-2.3.3/rdoc/

Answer 2

sudo gem rdoc --all --overwrite

Answer 3

إذا قمت بتثبيت القضبان مع RDOC (Sudo GEM Rails) يمكنك الوصول إليها عبر

gem server

Answer 4

فيما يلي محاولتي لتوضيح الخطوات قليلاً حول كيفية تنزيل مستندات Rails 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 Rails
4. هذا سوف يستغرق بعض الوقت. عندما يتم ذلك ، سيكون لديك دليل جديد يسمى DOC
5. يمكنك نقل دليل DOC في أي مكان تريده وفتح ملف Index.html في متصفح. لاحظ أنك لا تحتاج إلى خادم ويب لهذا العمل.

كملاحظة جانبية ، يبدو أن SDOC أصبحت مستندات رسميًا لـ Ruby on Rails API (انظر http://weblog.rubyonrails.org/2011/8/29/The-Rails-Api-switches-to-sdoc)

Answer 5

يمكنك تجميد القضبان في التطبيق والتشغيل rake doc:rails للحصول على المستندات.

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

يجب أن تكون RDOCs موجودة في دليل DOC/API. يمكنك استخدام rake rails:freeze:edge للحصول على توثيق لقضبان الحافة.

بدلاً من ذلك ، يمكنك تنزيل المستندات من موقع مثل القضبان الدماغ للحصول على قالب قابل للبحث معه أيضًا.

إذا كنت تريد أن تظهر المستندات gem server ثم قد يكون أسهل شيء هو إعادة تثبيت جوهرة القضبان مع خيار RDOC.

sudo gem install rails --rdoc

Answer 6

تشغيل الأمر bundle exec rdoc على سطر الأوامر.

سوف يولد جميع وثائق الكود الخاص بك.

Answer 7

من 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 8

إذا كنت بحاجة إلى إنشاء مستندات حافة ، فيمكنك أداء شيء من هذا القبيل

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 9

$ 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