Class: Nanoc::Filters::RDoc Private

Inherits:
Nanoc::Filter show all
Defined in:
lib/nanoc/filters/rdoc.rb

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

Constant Summary

Constants inherited from Nanoc::Filter

Nanoc::Filter::TMP_BINARY_ITEMS_DIR

Instance Attribute Summary

Attributes inherited from Nanoc::Filter

#assigns

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Nanoc::Filter

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

Methods included from Int::PluginRegistry::PluginMethods

#all, #identifier, #identifiers, #named, #register

Methods inherited from Int::Context

#get_binding, #initialize

Constructor Details

This class inherits a constructor from Nanoc::Filter

Class Method Details

.setup ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



6
7
8
9
 
# File 'lib/nanoc/filters/rdoc.rb', line 6

def self.setup
  gem 'rdoc', '~> 4.0'
  super
end

Instance Method Details

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

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

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

Parameters:

  • content (String) —

    The content to filter

Returns:

  • (String) —

    The filtered content



17
18
19
20
21
 
# File 'lib/nanoc/filters/rdoc.rb', line 17

def run(content, _params = {})
  options = ::RDoc::Options.new
  to_html = ::RDoc::Markup::ToHtml.new(options)
  ::RDoc::Markup.new.convert(content, to_html)
end