There´s a very nice version of the Rails 0.13.1 docs in CHM format here:
http://dema.ruby.com.br/articles/2005/08/16/rails-docs-in-chm-format
CHM is the Windows Help File format. This explains how to generate Rails documentation as a Windows Help file for installations running on Microsoft Windows.
It assumes that Ruby is installed on c:\ruby and rails 0.10.0 or newer is installed.
- Start a command prompt (and change to the drive with ruby installed by typing if nescessary):
c:
- Go to the gems directory.
cd \ruby\lib\ruby\gems\1.8\gems
- run rdoc:
rdoc -f chm -o chm_folder actionmailer-0.7.0 actionpack-1.5.0 actionwebservice-0.5.0 activerecord-1.7.0 activesupport-1.0.0 rails-0.10.0
(you’ll need to update the version number of each gem to the version installed on your system – you can get version numbers using ‘gem -list’)
NOTE: As an alternative, you can just run rdoc like:
rdoc -f chm -o chm_folder action* rails-*
- the resulting html-files and a chm file will be generated in the folder called
chm_folder
Note
.chm output generation requires that Microsoft’s Html Help Workshop is installed.
RDoc looks for it in:
c:\Program Files\HTML Help Workshop\hhc.exe
You can download a copy for free from:
http://msdn.microsoft.com/library/default.asp?url=/library/en-us/htmlhelp/html/hwMicrosoftHTMLHelpDownloads.asp
CHM on OSX
Chmox is a CHM reader for OS X.
There´s a very nice version of the Rails 0.13.1 docs in CHM format here:
http://dema.ruby.com.br/articles/2005/08/16/rails-docs-in-chm-format
CHM is the Windows Help File format. This explains how to generate Rails documentation as a Windows Help file for installations running on Microsoft Windows.
It assumes that Ruby is installed on c:\ruby and rails 0.10.0 or newer is installed.
- Start a command prompt (and change to the drive with ruby installed by typing if nescessary):
c:
- Go to the gems directory.
cd \ruby\lib\ruby\gems\1.8\gems
- run rdoc:
rdoc -f chm -o chm_folder actionmailer-0.7.0 actionpack-1.5.0 actionwebservice-0.5.0 activerecord-1.7.0 activesupport-1.0.0 rails-0.10.0
(you’ll need to update the version number of each gem to the version installed on your system – you can get version numbers using ‘gem -list’)
NOTE: As an alternative, you can just run rdoc like:
rdoc -f chm -o chm_folder action* rails-*
- the resulting html-files and a chm file will be generated in the folder called
chm_folder
Note
.chm output generation requires that Microsoft’s Html Help Workshop is installed.
RDoc looks for it in:
c:\Program Files\HTML Help Workshop\hhc.exe
You can download a copy for free from:
http://msdn.microsoft.com/library/default.asp?url=/library/en-us/htmlhelp/html/hwMicrosoftHTMLHelpDownloads.asp
CHM on OSX
Chmox is a CHM reader for OS X.