Documentation Generators

RDoc

RDoc produces HTML and command-line documentation for Ruby projects. RDoc includes the +rdoc+ and +ri+ tools for generating and displaying documentation from the command-line.

Rubygem rdoc

Total Downloads
30065460
Releases
60
Current Version
4.2.0
Released
2014-12-07 00:00:00 UTC
First Release
2008-04-10 07:00:00 UTC
Depends on following gems
Depending Gems
3511

Github rdoc/rdoc

Watchers
262
Forks
199
Development activity
Less active
Last commit
2015-02-24 06:58:52 UTC

Sdoc

rdoc generator html with javascript search index.

Rubygem sdoc

Total Downloads
6190842
Releases
31
Current Version
0.4.1
Released
2014-08-11 00:00:00 UTC
First Release
2009-04-23 20:00:00 UTC
Depends on following gems
Depending Gems
77

Github voloko/sdoc

Watchers
641
Forks
73
Development activity
Less active
Last commit
2014-10-18 19:53:06 UTC
Contributors
30
Issues

Yard

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.

Rubygem yard

Total Downloads
4975875
Releases
54
Current Version
0.8.7.6
Released
2014-10-26 00:00:00 UTC
First Release
2007-03-01 05:00:00 UTC
Depends on following gems
Depending Gems
3619

Github lsegal/yard

Watchers
958
Forks
181
Development activity
Less active
Last commit
2015-05-19 08:49:57 UTC
Contributors
30
Issues

DocumentUp

Pretty documentation generator for Github projects with proper Readme.

Github jeromegn/DocumentUp

Watchers
761
Forks
96
Development activity
Less active
Last commit
2015-01-27 14:59:13 UTC

rspec_api_documentation

Generate API docs from your test suite

Rubygem rspec_api_documentation

Total Downloads
130428
Releases
25
Current Version
4.4.0
Released
2015-04-28 00:00:00 UTC
First Release
2012-01-25 00:00:00 UTC
Depending Gems
3

Github zipmark/rspec_api_documentation

Watchers
513
Forks
140
Development activity
Less active
Last commit
2015-05-20 18:30:50 UTC

apipie-rails

Rails REST API documentation tool

Rubygem apipie-rails

Total Downloads
413854
Releases
34
Current Version
0.3.4
Released
2015-04-05 00:00:00 UTC
First Release
2012-07-21 00:00:00 UTC
Depends on following gems
Depending Gems
2

Github Pajk/apipie-rails

Watchers
327
Forks
88
Development activity
Less active
Last commit
2013-12-20 08:47:49 UTC
First commit
Contributors
21
Issues
Wiki pages

Rubygem ronn

Total Downloads
153816
Releases
7
Current Version
0.7.3
Released
2010-06-24 07:00:00 UTC
First Release
2010-03-08 08:00:00 UTC
Depends on following gems
Depending Gems
69

Github rtomayko/ronn

Watchers
651
Forks
33
Development activity
Inactive
Last commit
2013-08-14 08:05:09 UTC

Rubygem rocco

Total Downloads
49981
Releases
10
Current Version
0.8.2
Released
2011-08-27 00:00:00 UTC
First Release
2010-03-08 08:00:00 UTC
Depends on following gems
Depending Gems
33

Github rtomayko/rocco

Watchers
404
Forks
83
Development activity
Inactive
Last commit
2014-05-27 19:18:01 UTC
Contributors
22
Issues

Hanna

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.

Rubygem hanna

Total Downloads
17729
Releases
1
Current Version
0.1.12
Released
2009-10-16 01:00:00 UTC
First Release
2009-10-16 01:00:00 UTC

Github mislav/hanna

Watchers
229
Forks
26
Development activity
Inactive
Last commit
2010-07-17 20:16:53 UTC
Contributors
5
Issues

md2man

Converts markdown documents into UNIX manual pages.

Rubygem md2man

Total Downloads
22754
Releases
26
Current Version
3.0.2
Released
2014-10-26 00:00:00 UTC
First Release
2011-12-07 00:00:00 UTC
Depends on following gems
Depending Gems
4

Github sunaku/md2man

Watchers
203
Forks
15
Development activity
Less active
Last commit
2014-10-26 16:28:48 UTC
Top contributors
Contributors
5
Issues

Ajax-rdoc

Rdoc template and generator for Ruby source code that uses javascript to make searching for methods and classes very easy.

Github breakpointer/ajax-rdoc

Watchers
55
Forks
2
Development activity
Inactive
Last commit
2011-10-27 06:34:18 UTC
Top contributors
Contributors
1
Issues

annotator

Annotate your models and keep your comments about fields.

Rubygem annotator

Total Downloads
22208
Releases
9
Current Version
0.0.10
Released
2013-09-22 00:00:00 UTC
First Release
2012-02-19 00:00:00 UTC
Depends on following gems
Depending Gems
0

Github tech-angels/annotator

Watchers
63
Forks
6
Development activity
Inactive
Last commit
2013-09-22 16:21:12 UTC
First commit
Top contributors
Contributors
5
Issues

binman

Produces UNIX manual pages for executable scripts.

Rubygem binman

Total Downloads
33748
Releases
19
Current Version
4.0.0
Released
2014-10-26 00:00:00 UTC
First Release
2011-10-13 00:00:00 UTC
Depends on following gems
Depending Gems
3

Github sunaku/binman

Watchers
28
Forks
0
Development activity
Less active
Last commit
2014-10-26 16:27:15 UTC
Top contributors
Contributors
1
Issues

doc

Generate `Rakefile` with `docr` and get searchable documentation for ruby, rails, gems, plugins and all other ruby code in one place

Rubygem doc

Total Downloads
22823
Releases
15
Current Version
0.4.1
Released
2012-12-27 00:00:00 UTC
First Release
2010-12-15 21:00:00 UTC
Depends on following gems
Depending Gems
0

Github toy/doc

Watchers
7
Forks
3
Development activity
Inactive
Last commit
2012-12-28 18:09:11 UTC
Top contributors
Contributors
1
Issues

Erbook

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

Rubygem erbook

Total Downloads
26180
Releases
14
Current Version
9.2.1
Released
2009-11-18 08:00:00 UTC
First Release
2008-11-15 11:00:00 UTC
Depends on following gems
Depending Gems
0

Github sunaku/erbook

Watchers
7
Forks
0
Development activity
Inactive
Last commit
2010-04-03 22:10:32 UTC
Top contributors
Contributors
1
Issues
×

In order to continue, you must be signed in using your Github account.

If you're signing in using this account for the first time Github will ask for your permission to give access to your public user data to the Ruby Toolbox.

Although the Github Authorization page does not mention it, the request includes read-only access to your verified email address (user:email OAuth scope). This is neccessary so there's a way to notify you about comments, information about your accepted project edits and the like. You can review your notification settings on your account page once you're signed in.