Documentation Tools

yard

428

298
26
YARD is a documentation generation tool for the Ruby programming language. It enables the user to generate consistent, usable documentation that can be exported to a number of formats very easily, and also supports extending for custom Ruby constructs such as custom class level definitions. Last commit: Tue, 27 Jul 2010 04:21:40 +0000

gem install yard

Downloads: 19299

v0.5.8
3173

sdoc

349

269
16
rdoc html with javascript search index. Last commit: Tue, 15 Jun 2010 12:45:10 +0000

gem install sdoc

Downloads: 2729

v0.2.19
407

hanna

343

243
20
Hanna is an RDoc implemented in Haml, making its source clean and maintainable. It's built with simplicity, beauty and ease of browsing in mind. Last commit: Mon, 07 Jun 2010 10:07:59 +0000

gem install hanna

Downloads: 3166

v0.1.12
3166

ajax-rdoc

42

56
2
Rdoc template and generator for Ruby source code that uses javascript to make searching for methods and classes very easy. Last commit: Mon, 10 Nov 2008 17:33:24 +0000

erbook

4

5
0
ERBook 9.2.1 Write books, manuals, and documents in eRuby http://snk.tuxfamily.org/lib/erbook/ ERBook is an extensible document processor that emits [1]any document you can imagine from [2]eRuby templates, which allow scripting and dynamic content generation. Version 9.2.1 (2009-11-18) This release fixes some bugs in, and improves the readability and load time of, generated XHTML documents. Bug fixes * Prevent search button from starting search when search box untouched. * Prevent browser from fetching base-64 embedded URI sources by qualifying their digests with the "cid" URI schema, which is used to identify the parts of a multi-part e-mail message. This cuts down on the amount of "404 - File Not Found" errors on the web server which hosts your generated XHTML documents because web browsers will not confuse these embedded "cid" digests as being relative HTTP files. Housekeeping * Increase vertical spacing between [3]References for better readability. * Embed W3C validator badges as base-64 data URIs to reduce page load time. * Split the document processing code in ERBook::Document into smaller self-documenting methods. References 1. http://snk.tuxfamily.org/lib/erbook/#HelloWorld 2. http://en.wikipedia.org/wiki/ERuby 3. http://snk.tuxfamily.org/lib/erbook/#_references Last commit: Fri, 02 Apr 2010 07:19:36 +0000

gem install erbook

Downloads: 1950

v9.2.1
239

ron

0

0
0
ron -- the opposite of roff -- is now known as 'ronn' Last commit: Mon, 08 Mar 2010 12:50:17 +0000

gem install ron

Downloads: 778

v0.4
159