Ruby. Receptury

19.6. Publikowanie dokumentacji

Podziękowania dla Stefana Langa

Problem

Chcemy automatycznie zaktualizować witrynę WWW projektu w serwisie RubyForge (lub innym serwisie), przesyłając wygenerowaną dokumentację bądź własne strony.

Rozwiązanie

Jak pokazano w „19.2. Automatyczne generowanie dokumentacji”, język Rake udostępnia klasę RDocTask, która pozwala na generowanie dokumentacji RDoc:

require 'rake/rdoctask'

html_dir = 'doc/html'
library = 'MojaBiblioteka'
Rake::RDocTask.new('rdoc') do |t|
  t.rdoc_files.include('README', 'lib/**/*.rb')
  t.main = 'README'
  t.title = "Dokumentacja interfejsu API biblioteki #{library}"
  t.rdoc_dir = html_dir
end

W celu przesłania wygenerowanej dokumentacji do serwisu RubyForge, należy użyć tego zadania ...