We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
rake docs
1 parent 601fa9b commit af4da4bCopy full SHA for af4da4b
.yardopts
@@ -1,2 +1,3 @@
1
- CHANGELOG*
2
-o yard-docs
3
+--exclude spec
Gemfile
@@ -12,6 +12,7 @@ group :test do
12
end
13
14
group :development, :testing do
15
+ gem 'yard'
16
platforms :mri do
17
if RUBY_VERSION >= '2.0.0'
18
gem 'byebug'
Rakefile
@@ -35,3 +35,15 @@ RSpec::Core::RakeTask.new('spec:progress') do |spec|
35
36
37
task :default => :spec
38
+
39
+desc "Generate all documentation"
40
+task :docs => 'docs:yard'
41
42
+namespace :docs do
43
+ desc "Generate yard documention"
44
+ task :yard do
45
+ out = File.join('yard-docs', Mongoid::VERSION)
46
+ FileUtils.rm_rf(out)
47
+ system "yardoc -o #{out} --title mongoid-#{Mongoid::VERSION}"
48
+ end
49
+end
0 commit comments