Embedding RDoc in a Rails app
Rich Morin <[email protected]> Tue, 20 Feb 2007 02:41:24 -0800
| Newsgroups | gmane.comp.lang.ruby.documentation |
|---|---|
| Message-ID | <p06230911c2007d297d65@[192.168.1.205]> |
After putting together a "toy" application that plays Hangman in a rather devious manner: http://tchm.cfcl.com I made its (syntax-colored) source code available online: http://tchm.cfcl.com/code/index then made the generated RDoc pages available, as well: http://tchm.cfcl.com/rdoc/page?path=doc/app/index.html I'm rather a Ruby (and Rails) Nuby, so I suspect that parts of the implementation will make some readers shudder. However, I haven't seen anyone else doing this sort of thing, so I thought folks on this list might like to see a proof of concept. If I get really inspired, perhaps I'll look into adding some of the features I like on other documentation generators. As one example, I'd love to have the sort of clickable diagrams that Doxygen uses Graphviz to produce... -r -- http://www.cfcl.com/rdm Rich Morin http://www.cfcl.com/rdm/resume [email protected] http://www.cfcl.com/rdm/weblog +1 650-873-7841 Technical editing and writing, programming, and web development