RDoc vs Sandcastle Help File Builder
RDoc
ruby.github.ioSandcastle Help File Builder
github.comSide by side
| Figure | RDoc | Sandcastle Help File Builder |
|---|---|---|
| Price from | Free | Free |
| Free plan | Yes | Yes |
| Free trial | — | — |
| Open source | — | — |
| Windows | — | Yes |
| Linux | Yes | — |
| Self-hosted | Yes | — |
| Plans published | 1 | 1 |
| Spec score · Documentation Generators | 8.1 (#8) | 7.4 (#24) |
| Purpose | RDoc produces HTML and command-line documentation for Ruby projects, with `rdoc` and `ri` tools to generate and display it. | SHFB provides tools for building help files for managed class libraries, including conceptual topics and API reference topics. |
Plans
Sandcastle Help File Builder
- Sandcastle Help File BuilderFree
In their own words
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.
Sandcastle Help File Builder
Sandcastle Help File Builder has no write-up on Specifiction yet; its figures are above.