lsegal / yard
YARD is a Ruby Documentation tool (Yay!)
YARD is a documentation generation tool for the Ruby programming language. It enables the user to generate consistent, usable documentation that can be exported to a number of formats very easily, and also supports extending for custom Ruby constructs such as custom class level definitions.
Home
Welcome to the YARD wiki!
The YARD acronym can be expanded in any of several ways
(the ambiguity is semi-purposeful):
- “Yay! A Ruby Documentation tool”
- “Yarr! A Ruby Documentation tool” (on Pirate day)
- “Yet Another Ruby Documentation tool”
- “You Are Riting Docs!”
Here are some possibly useful pages:
- Assumptions – overview of
yardocassumptions
- Cache File Overview – overview of
.yardoccontents
- File Tree Overview – overview of the YARD file tree
- Resources – external web pages, IRC channel, etc.
- Who’s Using Yard? – list of projects using YARD
