Re: Ruby Docs with annotations and searching

> I looked at this some months ago, but had trouble running it. Plus, if I
> recall correctly, it required that I copy the ruby source files to
> subdirectory of the application, rather than than being able to point it
> at the an arbitrary directory.  (And I have a vague recollection of some
> other aspect that I thought would make it awkward in some ways, but
> cannot recall what that might have been.)
>
> Perhaps I'll give it another spin.

You don't have to put the docs in a subdirectory. There is a custom
YAML generator for RDoc that I wrote. You copy that to the RDoc
generators directory and then you can use the following command
anywhere you would use RDoc normally.

rdoc --fmt=yaml --opname=appname-0.2.3 ...

Once the YAML output file is generated there is an admin interface in
the Rails app that lets you upload the file. The Rails app then hosts
the docs in its DB for searching/annotating etc (and other features
like history diffing between two versions of a class or module).

> Yes, there is.  ruby-doc is built using Nitro, so an Og/Nitro solution
> would be preferred.  I started looking into the Nitro-based RDog tool,
> but time isn't always available to get things where I'd like them to be.

I'm not familiar with RDog, are there any example sites?

--
Conor