]> git.wincent.com - mkdtemp.git/commitdiff
Set up RDoc
authorWincent Colaiuta <win@wincent.com>
Sun, 28 Sep 2008 10:07:49 +0000 (12:07 +0200)
committerWincent Colaiuta <win@wincent.com>
Sun, 28 Sep 2008 10:07:49 +0000 (12:07 +0200)
Provide a top-level README and a Rake task for building RDoc
documentation.

Signed-off-by: Wincent Colaiuta <win@wincent.com>
Rakefile
doc/README [new file with mode: 0644]

index 08571b235960b5fbc2fb18cf8893544307001be2..cbc10a3e5eabe347d7dcac3bf4d18029359ef03b 100644 (file)
--- a/Rakefile
+++ b/Rakefile
@@ -15,6 +15,7 @@
 require 'rake'
 require 'rake/clean'
 require 'rake/gempackagetask'
+require 'rake/rdoctask'
 require 'rubygems'
 require 'spec/rake/spectask'
 require 'spec/rake/verify_rcov'
@@ -57,6 +58,19 @@ task :make do |t|
   system %{cd ext && ruby ./extconf.rb && make && cd -}
 end
 
+Rake::RDocTask.new do |t|
+  t.rdoc_files.include 'doc/README', 'ext/mkdtemp.c'
+  t.options           << '--charset' << 'UTF-8' << '--inline-source'
+  t.main              = 'doc/README'
+  t.title             = 'mkdtemp documentation'
+end
+
+desc 'Upload RDoc to RubyForge website'
+task :upload_rdoc => :rdoc do
+  sh 'scp -r html/* rubyforge.org:/var/www/gforge-projects/mkdtemp/'
+end
+
+
 SPEC = Gem::Specification.new do |s|
   s.name              = 'mkdtemp'
   s.version           = Dir::Mkdtemp::VERSION
diff --git a/doc/README b/doc/README
new file mode 100644 (file)
index 0000000..f741a34
--- /dev/null
@@ -0,0 +1,8 @@
+See Dir.mkdtemp for usage information.
+
+= Links
+
+* RubyForge project page: http://rubyforge.org/projects/mkdtemp
+* RDoc: http://mkdtemp.rubyforge.org
+* Source: http://git.wincent.com/mkdtemp.git
+* Author/maintainer: Wincent Colaiuta (win@wincent.com, http://wincent.com)