Re: Ruby Docs with annotations and searching

James Britt <[email protected]>
Newsgroups gmane.comp.lang.ruby.documentation
Organization ruby-doc.org
Message-ID <[email protected]>
Conor Hunt wrote:
> I recently released a new version of my Rannotate application that
> allows for annotations and searching of RDoc generated documentation.
> This version has many changes, a new interface and lots of new
> features.
> 
> Have a look here:
> Ruby 1.8.4 Docs - http://ruby.outertrack.com
> Rails Docs - http://rails.outertrack.com
> 
> It is basically a custom RDoc YAML generator and a Rails application
> that work together. The rubyforge project is at -
> http://rannotate.rubyforge.org

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.

> 
> I think that the ruby-lang site could benefit greatly from using this
> instead of the current combination of HTML docs and wiki. Is there any
> interest in trying to do that?

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.



Thanks,


James
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.