Class: Tilt::RDocTemplate

RDoc template. See: rdoc.rubyforge.org/

It‘s suggested that your program `require ‘rdoc/markup’` and `require ‘rdoc/markup/to_html’` at load time when using this template engine in a threaded environment.

Methods

allows_script? engine_initialized? evaluate initialize_engine markup prepare

Public Class methods

engine_initialized?()

[Source]

    # File lib/tilt/rdoc.rb, line 13
13:     def self.engine_initialized?
14:       defined? ::RDoc::Markup::ToHtml
15:     end

Public Instance methods

allows_script?()

[Source]

    # File lib/tilt/rdoc.rb, line 43
43:     def allows_script?
44:       false
45:     end

evaluate(scope, locals, &block)

[Source]

    # File lib/tilt/rdoc.rb, line 39
39:     def evaluate(scope, locals, &block)
40:       @output ||= @engine.to_s
41:     end

initialize_engine()

[Source]

    # File lib/tilt/rdoc.rb, line 17
17:     def initialize_engine
18:       require_template_library 'rdoc'
19:       require_template_library 'rdoc/markup'
20:       require_template_library 'rdoc/markup/to_html'
21:     end

markup()

[Source]

    # File lib/tilt/rdoc.rb, line 23
23:     def markup
24:       begin
25:         # RDoc 4.0
26:         require 'rdoc/options'
27:         RDoc::Markup::ToHtml.new(RDoc::Options.new, nil)
28:       rescue ArgumentError
29:         # RDoc < 4.0
30:         RDoc::Markup::ToHtml.new
31:       end
32:     end

prepare()

[Source]

    # File lib/tilt/rdoc.rb, line 34
34:     def prepare
35:       @engine = markup.convert(data)
36:       @output = nil
37:     end