Documenting with YARD
Rubydoc.info uses YARD to
generate all the documentation you see on the site. YARD is a
replacement to RDoc, the classic documentation system, but adds
many formatting and extensibility features that can make your life
easier! YARD is, for the most part, backwards compatible with RDoc
formatting. YARD, however, does not support directives such as
:nodoc:, but there are alternatives (see the "Where is
my :nodoc:?" article).
A good overview of the features added by YARD can be found in its README. Once you look over the basics, you will want to look at some examples of the formatting, which can be found in the Getting Started Guide.
Related Articles
Setting up a .yardopts file - Teaches you how to add extra options (or files) when generating documentation for your code.