Category

Documentation Generators

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

4.51
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 de...
2019
2020
2021
2022
2023
2024
4.36
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.
2019
2020
2021
2022
2023
2024
1.51
There's a lot of open issues
A long-lived project that still receives updates
Rails REST API documentation tool
2019
2020
2021
2022
2023
2024
1.51
No commit activity in last 3 years
No release in over 3 years
There's a lot of open issues
Inspired by TomDoc, KSS attempts to provide a methodology for writing maintainable, documented CSS within a team. Specifically, KSS is a CSS structure, documentation specification, and styleguide format. This is a ruby library for parsing KSS documented CSS and generating styleguides.
2019
2020
2021
2022
2023
2024
1.07
No release in over 3 years
Low commit activity in last 3 years
There's a lot of open issues
Generate API docs from your test suite
2019
2020
2021
2022
2023
2024
0.75
Low commit activity in last 3 years
Pretty documentation generator for Github projects with proper Readme.
0.55
No release in over 3 years
Low commit activity in last 3 years
There's a lot of open issues
Builds manuals
2019
2020
2021
2022
2023
2024
0.22
Repository is archived
No commit activity in last 3 years
No release in over 3 years
There's a lot of open issues
Docco in Ruby
2019
2020
2021
2022
2023
2024
0.14
No commit activity in last 3 years
No release in over 3 years
Converts markdown into UNIX manpages and HTML webpages.
2019
2020
2021
2022
2023
2024
0.05
No commit activity in last 3 years
No release in over 3 years
There's a lot of open issues
TomDoc is flexible code documentation with human readers in mind. The tomdoc gem is a Ruby library to discover and display TomDoc'd methods and classes. Given a Ruby file with TomDoc'd methods, tomdoc can generate HTML or print to the console. You can use it to query up a single method...
2019
2020
2021
2022
2023
2024
0.03
A long-lived project that still receives updates
RDoc generator designed with simplicity, beauty and ease of browsing in mind
2019
2020
2021
2022
2023
2024
0.03
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.
0.02
No commit activity in last 3 years
No release in over 3 years
Use TomDoc documentation format with YARD.
2019
2020
2021
2022
2023
2024
0.02
No commit activity in last 3 years
No release in over 3 years
schemadoc - document your database schemas (tables, columns, etc.)
2019
2020
2021
2022
2023
2024
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.
2019
2020
2021
2022
2023
2024
0.01
Repository is archived
No commit activity in last 3 years
No release in over 3 years
Generate `Rakefile` with `docr` and get searchable documentation for ruby, rails, gems, plugins and all other ruby code in one place
2019
2020
2021
2022
2023
2024
0.01
No commit activity in last 3 years
No release in over 3 years
Produces UNIX manual pages for executable scripts.
2019
2020
2021
2022
2023
2024
0.0
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 ...
2019
2020
2021
2022
2023
2024