From c225ca6843a2af1b5cfb75d624c6507e71dea108 Mon Sep 17 00:00:00 2001 From: Tijmen Brommet Date: Fri, 18 Nov 2016 15:55:42 +0000 Subject: [PATCH] Configure yard documentation tool Adds a `.yardopts` file to output documentation just for public code. --- .gitignore | 2 ++ .yardopts | 6 ++++++ slimmer.gemspec | 1 + 3 files changed, 9 insertions(+) create mode 100644 .yardopts diff --git a/.gitignore b/.gitignore index ee2141f..ce877b7 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,5 @@ slimmer-*.gem Gemfile.lock gemfiles/*.lock +.yardoc +docs diff --git a/.yardopts b/.yardopts new file mode 100644 index 0000000..b93c628 --- /dev/null +++ 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 index c38ca60..08e5981 100644 --- 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'