Doc-O-Matic vs RDoc
Doc-O-Matic
doc-o-matic.comRDoc
ruby.github.ioSide by side
| Figure | Doc-O-Matic | RDoc |
|---|---|---|
| Price from | — | Free |
| Free plan | — | Yes |
| Free trial | Yes | — |
| Open source | — | — |
| Windows | Yes | — |
| Linux | — | Yes |
| Self-hosted | — | Yes |
| Plans published | 2 | 1 |
| Spec score · Documentation Generators | 7.7 (#13) | 8.1 (#8) |
| Automation | A command-line compiler supports integration into automatic build processes. | The site documents generating RDoc through a Rake task and through a Ruby programmatic API. |
| Purpose | Doc-O-Matic generates source code and API documentation and authors general purpose documentation from source code, comments, conceptual topics, and external input. | RDoc produces HTML and command-line documentation for Ruby projects, with `rdoc` and `ri` tools to generate and display it. |
| Support | Technical support is free for users with valid licenses and is also available during the trial; the company says it aims to respond within 1 to 3 business days, usually in less than 24 hours. | The project directs users to CONTRIBUTING.md for filing bug reports. |
Plans
Doc-O-Matic
- Build ServerPrice not published
- Professional Pro (Desktop License)Price not published
In their own words
Doc-O-Matic
Doc-O-Matic has no write-up on Specifiction yet; its figures are above.
RDoc
RDoc is free software for producing Ruby project documentation as HTML pages and command-line reference output. The `rdoc` command generates documentation, while `ri` displays it. It processes Ruby, C, and RBS source files, plus RDoc markup, Markdown, RD, and TomDoc documents. RBS declarations can describe classes, modules, methods, attributes, and constants, and can add comments or type signatures to matching Ruby source documentation. A local preview server watches source files and refreshes the browser after changes. It uses Ruby’s built-in TCPServer and needs no external gems, but provides neither HTTPS nor HTTP/2 and is intended only for local previews. RDoc reports documentation coverage with `rdoc -C`, or includes parameter names with `rdoc -C1`. Generation can be automated through Rake or the RDoc API. Aliki is the default theme; Darkfish is deprecated. Ruby 3.2.0 or newer is required for the current gem.