RDoc
RDoc produces HTML and online documentation for Ruby projects. (by ruby)
Hanna
RDoc generator designed with simplicity, beauty and ease of browsing in mind (by jeremyevans)
Our great sponsors
The number of mentions indicates the total number of mentions that we've tracked plus the number of user suggested alternatives.
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
RDoc
Posts with mentions or reviews of RDoc.
We have used some of these posts to build our list of alternatives
and similar projects. The last one was on 2023-05-29.
-
Xeme: I'd value your opinion on my new Ruby gem
In addition to project documentation, you've included a lot of code comments. You could adopt a standardized format and use it to generate API documentation. RDoc and YARD are two options. If I were reviewing this code at work, I would probably ask you to remove comments that explain what, not why.
-
The right is on the left
That turns out to be a pretty common use case for markdown. Github, for example, renders your README.md is part of a git repo's "home" page. It's also common to have tooling that parses specially formatted comments in your source code and produce a documentation bundle, usually as a web page (ex. RDoc, YARD, JSDoc, etc.).
-
RDoc questions
I have an open (draft) documentation PR for RDoc over at GitHub (https://github.com/ruby/rdoc/pull/824) that has six unanswered questions. These are embedded in the committed text itself, and each is labelled as "Reviewers: ...."
- ¿Por qué aprender Ruby en 2021?
-
Generate API Docs
If you want to document your whole code base you should check https://github.com/ruby/rdoc
-
CVE-2021-31799: A command injection vulnerability in RDoc
I suspect the fix is to remove_unparseable, and the repository, like the CVE, just hasn't been updated yet.
-
Building Jekyll-Twitch, the gem
RDoc We'll use this gem to document our TwitchTag.rb class.
Hanna
Posts with mentions or reviews of Hanna.
We have used some of these posts to build our list of alternatives
and similar projects.
We haven't tracked posts mentioning Hanna yet.
Tracking mentions began in Dec 2020.
What are some alternatives?
When comparing RDoc and Hanna you can also consider the following projects:
YARD - YARD is a Ruby Documentation tool. The Y stands for "Yay!"
Apipie - Ruby on Rails API documentation tool
Asciidoctor - :gem: A fast, open source text processor and publishing toolchain, written in Ruby, for converting AsciiDoc content to HTML 5, DocBook 5, and other formats.
GitHub Changelog Generator - Automatically generate change log from your tags, issues, labels and pull requests on GitHub.
rspec_api_documentation - Automatically generate API documentation from RSpec
grape-swagger - Add OAPI/swagger v2.0 compliant documentation to your grape API
Annotate - Annotate Rails classes with schema and routes info