From: Graham Wideman <checkforrealaddress@...>
Date: 2006-09-02T05:05:31+09:00
Subject: RDoc: How to extend; YAML?

Folks:

I'm wanting to extend RDoc to produce module/class/method etc data in an 
alternative format.

Looks like the general principle is to add a generator module, and then 
command rdoc to use that using the fmt command line parameter.

OK so far, but two questions:

1. Project structure
---------------------
If I want to add an alternative-output extension, what's the right way to 
structure my project's files? I could add a generator module in the 
directory in the existing library where the library's rdoc looks for it, but 
that means adding my mess to the library. Or I could copy the entire 
library's rdoc tree to my own space... but copying the library seems wrong.

2. yaml
--------
What currently produces the yaml output that's sitting in:

D:\ruby\share\ri\1.8\system

3. RDoc Docs?
-------------

Are there any good docs on RDoc in general, and extending RDoc specifically 
(aside from the source code)?  Googling for "RDoc documentation" is not very 
satisfying :-).

Thanks,

Graham

-- 
---------------------------------------------------
Graham Wideman
Microsoft Visio MVP
---------------------------------------------------
Book/Tools:
Visio 2003 Developer's Survival Pack
Resources for programmable diagramming at:
http://www.diagramantics.com