Module: PDoc

Defined in:
lib/pdoc.rb,
lib/pdoc/error.rb,
lib/pdoc/models.rb,
lib/pdoc/parser.rb,
lib/pdoc/runner.rb,
lib/pdoc/treemaker.rb,
lib/pdoc/models/base.rb,
lib/pdoc/models/root.rb,
lib/pdoc/models/class.rb,
lib/pdoc/models/mixin.rb,
lib/pdoc/models/entity.rb,
lib/pdoc/models/section.rb,
lib/pdoc/models/utility.rb,
lib/pdoc/generators/json.rb,
lib/pdoc/models/argument.rb,
lib/pdoc/models/callable.rb,
lib/pdoc/models/constant.rb,
lib/pdoc/parser/fragment.rb,
lib/pdoc/models/container.rb,
lib/pdoc/models/namespace.rb,
lib/pdoc/models/signature.rb,
lib/pdoc/models/constructor.rb,
lib/pdoc/models/class_method.rb,
lib/pdoc/generators/html/page.rb,
lib/pdoc/models/class_property.rb,
lib/pdoc/generators/pythonesque.rb,
lib/pdoc/models/instance_method.rb,
lib/pdoc/generators/html/helpers.rb,
lib/pdoc/generators/html/website.rb,
lib/pdoc/generators/html/template.rb,
lib/pdoc/models/instance_property.rb,
lib/pdoc/generators/abstract_generator.rb,
lib/pdoc/generators/html/syntax_highlighter.rb

Defined Under Namespace

Modules: Generators, Models Classes: Fragment, PDocError, ParseError, Parser, Runner, Serializer, Treemaker

Class Method Summary collapse

Class Method Details

.copy_templates(template_type, destination) ⇒ Object 



27
28
29
30
31
 
# File 'lib/pdoc.rb', line 27

def self.copy_templates(template_type, destination)
  dir = File.expand_path(destination)
  raise "File already exists: #{destination}" if File.exist?(dir)
  FileUtils.cp_r("#{TEMPLATES_DIR}/#{template_type}", dir)
end

.run(options = {}) ⇒ Object 



23
24
25
 
# File 'lib/pdoc.rb', line 23

def self.run(options = {})
  Runner.new(options.dup).run
end