So you've written a masterpiece, a class in a class of its own, and you'd like to share it with the world. But, being a responsible developer, you feel the need to document your creation. The simplest solution is to use Ruby's built-in documentation format, RD, and rdtool , a Ruby utility suite that converts this documentation into a variety of output formats. This text is assumed to be documentation in RD format.
Lines starting with one to four equals signs are headings.
Lines in which the first nonspace is an asterisk indicate the beginnings of bullet lists. Continuation lines for each bullet item should line up with the text on the first line. Lists may be nested. The actual digits used are ignored. Again, lists may be nested.