Module: Ronn

Defined in:

lib/ronn.rb,
lib/ronn/roff.rb,
lib/ronn/document.rb

Overview

Ronn is a humane text format and toolchain for authoring manpages (and things that appear as manpages from a distance). Use it to build / install standard UNIX roff(7) formatted manpages or to generate beautiful HTML manpages.

Defined Under Namespace

Classes: Document, RoffFilter

Constant Summary

VERSION =

'0.5'

Class Method Summary

• .new(filename, attributes = {}, &block) ⇒ Object

  Create a new Ronn::Document for the given ronn file.

Class Method Details

.new(filename, attributes = {}, &block) ⇒ Object

Create a new Ronn::Document for the given ronn file. See Ronn::Document.new for usage information.

# File 'lib/ronn.rb', line 13

def self.new(filename, attributes={}, &block)
  Document.new(filename, attributes, &block)
end