Category

Documentation Generators

Tools for creating API documentation of your Ruby software and it's exposed interfaces

10.35
A long-lived project that still receives updates
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.
 Popularity
Downloads
69,427,170
Stars
513
Forks
338
Watchers
43
 Releases
Current version
6.1.1
Total releases
81
First release
Latest release
 Activity
Issue Closure Rate
83%
Pull Request Acceptance Rate
84%
Average date of last 50 commits
Reverse Dependencies
4,289
7.12
A long-lived project that still receives updates
rdoc generator html with javascript search index.
 Popularity
Downloads
50,339,773
Stars
758
Forks
88
Watchers
15
 Releases
Current version
1.0.0
Total releases
38
First release
Latest release
 Activity
Issue Closure Rate
96%
Pull Request Acceptance Rate
82%
Average date of last 50 commits
Reverse Dependencies
84
4.58
A long-lived project that still receives updates
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.
 Popularity
Downloads
24,798,081
Stars
1,471
Forks
298
Watchers
37
 Releases
Current version
0.9.16
Total releases
71
First release
Latest release
 Activity
Issue Closure Rate
94%
Pull Request Acceptance Rate
55%
Average date of last 50 commits
Reverse Dependencies
5,729
1.77
There's a lot of open issues
A long-lived project that still receives updates
Rails REST API documentation tool
 Popularity
Downloads
2,289,631
Stars
1,917
Forks
340
Watchers
35
 Releases
Current version
0.5.15
Total releases
54
First release
Latest release
 Activity
Issue Closure Rate
42%
Pull Request Acceptance Rate
76%
Average date of last 50 commits
Reverse Dependencies
5
1.19
A long-lived project that still receives updates
Generate API docs from your test suite
 Popularity
Downloads
1,371,589
Stars
1,182
Forks
259
Watchers
25
 Releases
Current version
6.1.0
Total releases
34
First release
Latest release
 Activity
Issue Closure Rate
80%
Pull Request Acceptance Rate
69%
Average date of last 50 commits
Reverse Dependencies
6
0.6
No commit activity in last 3 years
Pretty documentation generator for Github projects with proper Readme.
 Popularity
Stars
890
Forks
89
Watchers
18
 Activity
Issue Closure Rate
77%
Pull Request Acceptance Rate
57%
Average date of last 50 commits
0.39
No release in over 3 years
Low commit activity in last 3 years
There's a lot of open issues
Builds manuals
 Popularity
Downloads
658,477
Stars
1,094
Forks
55
Watchers
21
 Releases
Current version
0.7.3
Total releases
7
First release
Latest release
 Activity
Issue Closure Rate
55%
Pull Request Acceptance Rate
37%
Average date of last 50 commits
Reverse Dependencies
84
0.19
Repository is archived
No release in over 3 years
Low commit activity in last 3 years
There's a lot of open issues
Docco in Ruby
 Popularity
Downloads
131,726
Stars
406
Forks
76
Watchers
8
 Releases
Current version
0.8.2
Total releases
10
First release
Latest release
 Activity
Issue Closure Rate
69%
Pull Request Acceptance Rate
42%
Average date of last 50 commits
Reverse Dependencies
35
0.17
A long-lived project that still receives updates
Converts markdown into UNIX manpages and HTML webpages.
 Popularity
Downloads
66,652
Stars
298
Forks
20
Watchers
13
 Releases
Current version
5.1.2
Total releases
32
First release
Latest release
 Activity
Issue Closure Rate
95%
Pull Request Acceptance Rate
28%
Average date of last 50 commits
Reverse Dependencies
9
0.13
No commit activity in last 3 years
No release in over 3 years
There's a lot of open issues
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.
 Popularity
Downloads
20,482
Stars
234
Forks
17
Watchers
3
 Releases
Current version
0.1.12
Total releases
1
First release
Latest release
 Activity
Issue Closure Rate
43%
Pull Request Acceptance Rate
0%
Average date of last 50 commits
Reverse Dependencies
28
0.05
Repository is archived
No commit activity in last 3 years
Rdoc template and generator for Ruby source code that uses javascript to make searching for methods and classes very easy.
 Popularity
Stars
56
Forks
2
Watchers
2
 Activity
Pull Request Acceptance Rate
0%
Average date of last 50 commits
0.03
Low commit activity in last 3 years
No release in over a year
Produces UNIX manual pages for executable scripts.
 Popularity
Downloads
88,654
Stars
36
Forks
2
Watchers
1
 Releases
Current version
5.1.0
Total releases
23
First release
Latest release
 Activity
Issue Closure Rate
100%
Average date of last 50 commits
Reverse Dependencies
3
0.02
No release in over 3 years
Low commit activity in last 3 years
schemadoc - document your database schemas (tables, columns, etc.)
 Popularity
Downloads
6,322
Stars
53
Forks
1
Watchers
2
 Releases
Current version
1.1.0
Total releases
6
First release
Latest release
 Activity
Pull Request Acceptance Rate
100%
Average date of last 50 commits
Reverse Dependencies
0
0.02
No commit activity in last 3 years
No release in over 3 years
There's a lot of open issues
Annotate your models and keep your comments about fields.
 Popularity
Downloads
36,614
Stars
66
Forks
4
Watchers
9
 Releases
Current version
0.0.10
Total releases
9
First release
Latest release
 Activity
Issue Closure Rate
55%
Pull Request Acceptance Rate
100%
Average date of last 50 commits
Reverse Dependencies
0
0.01
Repository is archived
Low commit activity in last 3 years
No release in over a year
Generate `Rakefile` with `docr` and get searchable documentation for ruby, rails, gems, plugins and all other ruby code in one place
 Popularity
Downloads
36,026
Stars
7
Forks
3
Watchers
1
 Releases
Current version
0.5.0
Total releases
16
First release
Latest release
 Activity
Pull Request Acceptance Rate
0%
Average date of last 50 commits
Reverse Dependencies
0
0.01
No release in over 3 years
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
 Popularity
Downloads
37,152
 Releases
Current version
9.2.1
Total releases
14
First release
Latest release
 Activity
Reverse Dependencies
0