Contents

require 'corundum/documentation-task'
require 'yard'

module Corundum
  class YARDoc < DocumentationTask
    title "YARD API documentation"
    default_namespace :yardoc

    setting :gemspec

    settings(:options =>  nil,
             :readme =>  nil,
             :sub_dir =>  "yardoc",
             :files =>  nested(:code => [], :docs => []),
             :extra_files =>  [] )

    settings(:server_options => [],
             :server => nested(
               :port => 8888,
               :docroot => "/tmp/yard",
               :plugins => [])
            )


    def document_inputs
      FileList["README*"] + files.code + files.docs + extra_files
    end

    def default_configuration(toolkit)
      super
      self.gemspec = toolkit.gemspec
      toolkit.files.copy_settings_to(self.files)
      self.files.docs = []
    end

    def resolve_configuration
      self.options ||= gemspec.rdoc_options
      self.options += [ "--readme", readme ] if readme
      self.options += files.code
      unless files.docs.empty? and extra_files.empty?
        self.options += [ "-" ] + files.docs  + extra_files
      end
      super
      self.options += [ "--output-dir", target_dir]


      self.server_options += ["--reload"]
      self.server_options += ["--port", server.port.to_s]
      self.server_options += ["--docroot", server.docroot]
      self.server.plugins.each do |plugin|
        self.server_options += ["--plugin", plugin]
      end
    end

    def define
      in_namespace do
        file entry_point => document_inputs do
          YARD::CLI::Yardoc.run( *(options) )
        end

        desc "Start a live YARD server for editing inline docs"
        task :live do
          YARD::CLI::Server.run( *(options + server_options) )
        end
      end

      super
    end
  end
end

Version data entries

30 entries across 30 versions & 1 rubygems

Version	Path
corundum-0.3.9	lib/corundum/documentation/yardoc.rb
corundum-0.3.8	lib/corundum/documentation/yardoc.rb
corundum-0.3.7	lib/corundum/documentation/yardoc.rb
corundum-0.3.6	lib/corundum/documentation/yardoc.rb
corundum-0.3.5	lib/corundum/documentation/yardoc.rb
corundum-0.3.4	lib/corundum/documentation/yardoc.rb
corundum-0.3.3	lib/corundum/documentation/yardoc.rb
corundum-0.3.2	lib/corundum/documentation/yardoc.rb
corundum-0.3.1	lib/corundum/documentation/yardoc.rb
corundum-0.3	lib/corundum/documentation/yardoc.rb
corundum-0.2	lib/corundum/documentation/yardoc.rb
corundum-0.1.4	lib/corundum/documentation/yardoc.rb
corundum-0.1.3	lib/corundum/documentation/yardoc.rb
corundum-0.1.2	lib/corundum/documentation/yardoc.rb
corundum-0.1.0	lib/corundum/documentation/yardoc.rb
corundum-0.0.31	lib/corundum/documentation/yardoc.rb
corundum-0.0.30	lib/corundum/documentation/yardoc.rb
corundum-0.0.29	lib/corundum/documentation/yardoc.rb
corundum-0.0.28	lib/corundum/documentation/yardoc.rb
corundum-0.0.27	lib/corundum/documentation/yardoc.rb