Module: Ronn

Defined in:

lib/ronn.rb,
lib/ronn/roff.rb,
lib/ronn/server.rb,
lib/ronn/document.rb,
lib/ronn/template.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

Modules: Server Classes: Document, RoffFilter, Template

Constant Summary

REV =

bring REV up to date with: rake rev

'0.6.0'

VERSION =

REV[/(?:[\d.]+)(?:-\d+)?/].tr('-', '.')

Class Method Summary

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

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

• .release? ⇒ Boolean

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 8

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

.release? ⇒ Boolean

Returns:

• (Boolean)

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

def self.release?
  REV != '' && !REV.include?('-')
end