Configure yard documentation tool

Adds a `.yardopts` file to output documentation just for public code.
alphagov · Nov 21, 2016 · c225ca6 · c225ca6
1 parent bc0b36b
commit c225ca6
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,5 @@
 slimmer-*.gem
 Gemfile.lock
 gemfiles/*.lock
+.yardoc
+docs
diff --git a/.yardopts b/.yardopts
@@ -0,0 +1,6 @@
+--no-private
+--markup markdown
+--output-dir docs
+--embed-mixins
+--no-stats
+--api public
diff --git a/slimmer.gemspec b/slimmer.gemspec
@@ -26,6 +26,7 @@ Gem::Specification.new do |s|
   s.add_dependency 'activesupport'
 
   s.test_files    = Dir['test/**/*']
+  s.add_development_dependency 'yard', '0.8.7.6'
   s.add_development_dependency 'minitest', '~> 5.4'
   s.add_development_dependency 'rake', '~> 0.9.2.2'
   s.add_development_dependency 'rack-test', '~> 0.6.1'