Adds link to API reference

Lujaw · Nov 26, 2011 · c9dfc35 · c9dfc35
1 parent 92ffd9f
commit c9dfc35
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 268 deletions.
diff --git a/.gitignore b/.gitignore
@@ -6,3 +6,5 @@ sunspot_rails/spec/rails2/vendor
 sunspot_rails/spec/rails3/vendor
 **/*/vendor/bundle
 sunspot-solr.pid
+.yardoc
+docs
diff --git a/README.md b/README.md
@@ -11,6 +11,10 @@ searching for them.
 Sunspot is designed to be easily plugged in to any ORM, or even non-database-backed
 objects such as the filesystem.
 
+This README provides a high level overview; class-by-class and
+method-by-method documentation is available in the [API
+reference](http://sunspot.github.com/sunspot/docs/).
+
 ## Quickstart with Rails 3
 
 Add to Gemfile:

diff --git a/README.rdoc b/README.rdoc
diff --git a/Rakefile b/Rakefile
@@ -27,11 +27,19 @@ task :release do
   end
 end
 
-
 desc 'Run all the tests'
 task :default do
   exit system([ "GEM=sunspot ci/travis.sh",
                 "GEM=sunspot_rails RAILS=2.3.14 ci/travis.sh",
                 "GEM=sunspot_rails RAILS=3.0.11 ci/travis.sh",
                 "GEM=sunspot_rails RAILS=3.1.3 ci/travis.sh" ].join(" && ")) ? 0 : 1
 end
+
+begin
+  require 'yard/rake/yardoc_task'
+  YARD::Rake::YardocTask.new do |t|
+    t.files   = ['*/lib/**/*.rb']
+    t.options = ['-o docs', '-M redcarpet']
+  end
+rescue LoadError
+end