RDoc
RDoc produces HTML and online documentation for Ruby projects. (by ruby)
rubydoc.info
Next generation rdoc.info site (by docmeta)
| RDoc | rubydoc.info | |
|---|---|---|
| 8 | 6 | |
| 820 | 132 | |
| 0.0% | 0.0% | |
| 8.7 | 5.3 | |
| about 19 hours ago | 8 months ago | |
| Ruby | Ruby | |
| GNU General Public License v3.0 or later | MIT License |
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.
rubydoc.info
Posts with mentions or reviews of rubydoc.info.
We have used some of these posts to build our list of alternatives
and similar projects. The last one was on 2023-07-07.
-
What's the Difference Between `ruby-doc.org` and `docs.ruby-lang.org`?
Yes, I use rubydoc.info to refer to the docs for gems, didn't realize until now that it also includes documentation for Ruby itself. Thanks!
-
Xeme: I'd value your opinion on my new Ruby gem
GitHub will render markdown (and other formats), but I don't believe it supports parsing and rendering YARD or RDoc. Both tools ship with tools that generate documentation websites that you can use for your project. YARD also has https://rubydoc.info
-
Is anybody aware that rubydoc.info is down?
Right now, gemdocs.org is very similar to rubydoc.info as it both uses YARD, with rubydoc.info supporting custom YARD plugins for gems (which might make some gem output look better if they specify said plugins). I have some ideas for improving Ruby documentation in general, so I've been trying to not add too much functionality to YARD as I might be trying to pivot back to RDoc.
-
What's the skinny re: rubydoc.info?
The experiment is: can I pre-generate and store the docs forever? Everyone is probably going to say sure, stick them on S3 and forget about it. But how does that get funded? Who is going to pay for that? rubydoc.info is hosted via sponsorship.
-
What's up with rubydoc.info?
rubydoc.info is supported by one person and is open-source. Care to report the problems here: https://github.com/docmeta/rubydoc.info ?
What are some alternatives?
When comparing RDoc and rubydoc.info you can also consider the following projects:
YARD - YARD is a Ruby Documentation tool. The Y stands for "Yay!"
chunky_png - Read/write access to PNG images in pure Ruby.
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.
sord - Convert YARD docs to Sorbet RBI and Ruby 3/Steep RBS files
Apipie - Ruby on Rails API documentation tool
grape-swagger - Add OAPI/swagger v2.0 compliant documentation to your grape API
rdoc-markdown - RDoc to Markdown generator
Annotate - Annotate Rails classes with schema and routes info
rubocop - A Ruby static code analyzer and formatter, based on the community Ruby style guide.
rspec_api_documentation - Automatically generate API documentation from RSpec
zeal - Offline documentation browser inspired by Dash