RDoc
Documentation
DISCONTINUED
Our great sponsors
RDoc | Documentation | |
---|---|---|
8 | 0 | |
819 | 216 | |
0.9% | - | |
8.8 | 0.0 | |
3 days ago | about 1 year ago | |
Ruby | Ruby | |
GNU General Public License v3.0 or later | MIT License |
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
-
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.).
- ¿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.
Documentation
We haven't tracked posts mentioning Documentation yet.
Tracking mentions began in Dec 2020.
What are some alternatives?
YARD - YARD is a Ruby Documentation tool. The Y stands for "Yay!"
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.
Apipie - Ruby on Rails API documentation tool
grape-swagger - Add OAPI/swagger v2.0 compliant documentation to your grape API
Annotate - Annotate Rails classes with schema and routes info
rspec_api_documentation - Automatically generate API documentation from RSpec
Hanna - RDoc generator designed with simplicity, beauty and ease of browsing in mind
rswag - Seamlessly adds a Swagger to Rails-based API's
Apidoco - Ruby on Rails API documentation tool
GitHub Changelog Generator - Automatically generate change log from your tags, issues, labels and pull requests on GitHub.