Add a rake docs task (mongodb#4520)

* Add a `rake docs` task * Exclude specs from documentation * ci
johnnyshields · Aug 16, 2018 · af4da4b · af4da4b
1 parent 601fa9b
commit af4da4b
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 0 deletions.
diff --git a/.yardopts b/.yardopts
@@ -1,2 +1,3 @@
 - CHANGELOG*
 -o yard-docs
+--exclude spec
diff --git a/Gemfile b/Gemfile
@@ -12,6 +12,7 @@ group :test do
 end
 
 group :development, :testing do
+  gem 'yard'
   platforms :mri do
     if RUBY_VERSION >= '2.0.0'
       gem 'byebug'

diff --git a/Rakefile b/Rakefile
@@ -35,3 +35,15 @@ RSpec::Core::RakeTask.new('spec:progress') do |spec|
 end
 
 task :default => :spec
+
+desc "Generate all documentation"
+task :docs => 'docs:yard'
+
+namespace :docs do
+  desc "Generate yard documention"
+  task :yard do
+    out = File.join('yard-docs', Mongoid::VERSION)
+    FileUtils.rm_rf(out)
+    system "yardoc -o #{out} --title mongoid-#{Mongoid::VERSION}"
+  end
+end