Skip to content

Commit 87122fa

Browse files
committed
Use YARD for documentation
1 parent ef94340 commit 87122fa

3 files changed

Lines changed: 11 additions & 1 deletion

File tree

.yardopts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
--output-dir doc/reference
2+
--markup markdown
3+
--no-private
4+
lib/**/*.rb
5+
-
6+
doc/text/*

Rakefile

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,16 @@
11
require "bundler/gem_helper"
2+
require "yard"
23

34
base_dir = File.expand_path("..", __FILE__)
45
helper = Bundler::GemHelper.new(base_dir)
56
helper.install
6-
spec = helper.gemspec
77

88
desc "Run test"
99
task :test do
1010
ruby("test/run-test.rb")
1111
end
1212

1313
task default: :test
14+
15+
YARD::Rake::YardocTask.new do |task|
16+
end

unicode_plot.gemspec

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,4 +34,5 @@ Gem::Specification.new do |spec|
3434
spec.add_development_dependency "bundler", ">= 1.17"
3535
spec.add_development_dependency "rake"
3636
spec.add_development_dependency "test-unit"
37+
spec.add_development_dependency "yard"
3738
end

0 commit comments

Comments
 (0)