Contents

require 'mattock/tasklib'

module Corundum
  class DocumentationTask < Mattock::TaskLib
    setting :title
    setting :browser
    setting :gemspec

    setting :corundum_dir
    setting :docs_root

    setting :target_dir
    setting :sub_dir

    setting :entry_file, "index.html"

    #The path from the project root to the entry file
    #Resolves if unset to target_dir + entry_file
    setting :entry_path

    #The URL path from this documentation root
    #Resolves if unset to sub_dir + entry_file
    setting :entry_link


    def self.title(name)
      setting :title, name
    end

    def default_configuration(toolkit)
      toolkit.copy_settings_to(self)
    end

    def resolve_configuration
      if unset?(docs_root)
        self.docs_root = File::join(corundum_dir, "docs")
      end

      if unset?(target_dir)
        self.target_dir = File::join(docs_root, sub_dir)
      else
        self.sub_dir = target_dir.sub(/^#{docs_root}\//,"")
      end

      if unset?(entry_path)
        self.entry_path = File::join(target_dir, entry_file)
      end

      if unset?(entry_link)
        self.entry_link = File::join(sub_dir, entry_file)
      end
    end

    def entry_point(under = nil)
      File::join(under || target_dir, entry_file)
    end

    def define
      directory target_dir

      in_namespace do
        desc "Open up a browser to view your documentation"
        BrowserTask.new(self) do |t|
          t.index_html = entry_point
        end
      end
    end
  end
end

Version data entries

9 entries across 9 versions & 1 rubygems

Version	Path
corundum-0.0.24	lib/corundum/documentation-task.rb
corundum-0.0.23	lib/corundum/documentation-task.rb
corundum-0.0.22	lib/corundum/documentation-task.rb
corundum-0.0.20	lib/corundum/documentation-task.rb
corundum-0.0.19	lib/corundum/documentation-task.rb
corundum-0.0.18	lib/corundum/documentation-task.rb
corundum-0.0.17	lib/corundum/documentation-task.rb
corundum-0.0.16	lib/corundum/documentation-task.rb
corundum-0.0.15	lib/corundum/documentation-task.rb