Class: Nanoc3::Filters::RDoc

Inherits:
Nanoc3::Filter show all
Defined in:
lib/nanoc3/filters/rdoc.rb

Constant Summary

Constants inherited from Nanoc3::Filter

Nanoc3::Filter::TMP_BINARY_ITEMS_DIR

Instance Attribute Summary

Attributes inherited from Nanoc3::Filter

#assigns

Instance Method Summary collapse

Methods inherited from Nanoc3::Filter

#depend_on, #filename, from_binary?, #initialize, #output_filename, to_binary?, type

Methods included from PluginRegistry::PluginMethods

#identifier, #identifiers, #named, #register

Methods inherited from Context

#get_binding, #initialize

Constructor Details

This class inherits a constructor from Nanoc3::Filter

Instance Method Details

#run(content, params = {}) ⇒ String

Runs the content through [RDoc::Markup](rdoc.rubyforge.org/RDoc/Markup.html). This method takes no options.

Parameters:

  • content (String) —

    The content to filter

Returns:

  • (String) —

    The filtered content



22
23
24
25
26
27
28
29
30
 
# File 'lib/nanoc3/filters/rdoc.rb', line 22

def run(content, params={})
  begin
    # new RDoc
    ::RDoc::Markup.new.convert(content, ::RDoc::Markup::ToHtml.new)
  rescue LoadError
    # old RDoc
    ::SM::SimpleMarkup.new.convert(content, ::SM::ToHtml.new)
  end
end