I did a "cvs co -rruby_1_8 ruby" (thanks, Ryan!) and ran rdoc over the
base directory to create the docs for the core API.
You can see them at
http://www.ruby-doc.org/src/ruby/rdocs/
The net steps are
* Write a script (rake or otherwise) to do the cvs up and rdoc build
* Test the script
* cron it for once a day or something
Ryan, can you drop a line here when you've made a doc commit so I can
check that I'm indeed pulling the correct files from CVS and that the
resulting rdocs are showing the changes?
Thanks,
James
P.S.
It suddenly struck me that that the main pages for each of the core *.c
files have zero content. For example, when you go to the above URL, the
default page is array.c. And the bottom frame is a wasteland.
Simple option: Build the rdocs with a specific main page that has some
value (whatever that may be. Maybe an intro to navigating the rdoc
pages?). *.c pages are still null, but you don't stare at one right off
the bat.
Less simple option (but can be combined with Simple Option): Add
comments to *.c files so that the rdocs show something useful in that
bottom frame.
Another less simple option: Change the frame layout to omit the *.c
links. Are the links in the top-left corner really useful? They seem
to duplicate (if they say anything at all) the info in the class file links.
|
