module Rake::DevEiate::Docs
Documentation-generation tasks
Public Instance Methods
define_tasks()
click to toggle source
Define documentation tasks
Calls superclass method
# File lib/rake/deveiate/docs.rb, line 16 def define_tasks super if defined?( super ) task :docs => :phony RDoc::Task.new( 'docs' ) do |rdoc| rdoc.main = self.readme_file.to_s rdoc.rdoc_files = self.rdoc_files rdoc.generator = :fivefish rdoc.title = self.title rdoc.rdoc_dir = Rake::DevEiate::DOCS_DIR.to_s end if self.publish_to target = self.publish_to desc "Publish API docs to #{target}" task :publish_docs => :docs do target = File.join( target, self.name ) unless target.end_with?( self.name ) sh 'rsync', '-COva', Rake::DevEiate::DOCS_DIR.to_s + '/', target end end task :debug => :docs_debug task( :docs_debug, &method(:do_docs_debug) ) end
do_docs_debug( task, args )
click to toggle source
Task body for the :docs_debug task
# File lib/rake/deveiate/docs.rb, line 45 def do_docs_debug( task, args ) self.prompt.say( "Docs are published to:", color: :bright_green ) if ( publish_url = self.publish_to ) self.prompt.say( self.indent(publish_url, 4) ) else self.prompt.say( self.indent("n/a"), color: :bright_yellow ) end self.prompt.say( "\n" ) end