Permalink
Browse files

Setup YARD properly

  • Loading branch information...
1 parent e828a85 commit 0e4f242c60a37733ceab558e471bab629db54606 @titanous titanous committed Jul 27, 2010
Showing with 10 additions and 16 deletions.
  1. +0 −5 .document
  2. +4 −0 .yardopts
  3. +6 −6 README.rdoc → README.md
  4. +0 −5 Rakefile
View
@@ -1,5 +0,0 @@
-README.rdoc
-lib/**/*.rb
-bin/*
-features/**/*.feature
-LICENSE
View
@@ -0,0 +1,4 @@
+--title 'Mailman Documentation'
+-
+LICENSE
+USER_GUIDE.md
View
@@ -1,17 +1,17 @@
-= Mailman
+# Mailman
Mailman is an incoming mail processing microframework (with POP, IMAP, and
MTA support), that works with Rails "out of the box", and is compatible with
other popular ruby web frameworks, complete with a routing DSL and bounce
detection.
-See `USER_GUIDE.md` for more information.
+See the {file:USER_GUIDE.md} for more information.
-== Thanks
+## Thanks
-This project is sponsored by the {Ruby Summer of Code}[http://rubysoc.org],
-and my mentor is {Steven Soroka}[http://github.com/ssoroka].
+This project is sponsored by the [Ruby Summer of Code](http://rubysoc.org),
+and my mentor is [Steven Soroka](http://github.com/ssoroka).
-== Copyright
+## Copyright
Copyright (c) 2010 Jonathan Rudenberg. See LICENSE for details.
View
@@ -12,8 +12,3 @@ Spec::Rake::SpecTask.new(:rcov) do |spec|
end
task :default => :spec
-
-require 'yard'
-YARD::Rake::YardocTask.new do |doc|
- doc.options = ['--title', 'Mailman']
-end

0 comments on commit 0e4f242

Please sign in to comment.