Skip to content

Commit bf886b2

Browse files
committed
- bring back yard
1 parent 2c28506 commit bf886b2

File tree

4 files changed

+10
-1
lines changed

4 files changed

+10
-1
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,3 +42,5 @@ tmp/
4242

4343
gemfiles/*.lock
4444

45+
doc/
46+
.yardoc/

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
[![Gem Version](https://badge.fury.io/rb/keynote.svg)](https://rubygems.org/gems/keynote)
22
[![Build](https://github.com/evilmartians/keynote/workflows/Build/badge.svg)](https://github.com/evilmartians/keynote/actions)
3+
[![Docs](https://img.shields.io/badge/docs-link-blue.svg)(https://rubydoc.info/gems/keynote)]
34

45
# Keynote
56

Rakefile

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,4 +31,9 @@ task :nextify do
3131
sh "bundle exec ruby-next nextify -V"
3232
end
3333

34+
require "yard"
35+
YARD::Rake::YardocTask.new do |t|
36+
t.files = ['"lib/**/*.rb"]
37+
end
38+
3439
task default: %w[rubocop rubocop:md spec test]

keynote.gemspec

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Gem::Specification.new do |s|
1717
s.metadata = {
1818
"bug_tracker_uri" => "https://github.com/evilmartians/keynote/issues",
1919
"changelog_uri" => "https://github.com/evilmartians/keynote/blob/master/CHANGELOG.md",
20-
"documentation_uri" => "https://github.com/evilmartians/keynote",
20+
"documentation_uri" => "https://rubydoc.info/gems/keynote",
2121
"homepage_uri" => "https://github.com/evilmartians/keynote",
2222
"source_code_uri" => "https://github.com/evilmartians/keynote"
2323
}
@@ -41,6 +41,7 @@ Gem::Specification.new do |s|
4141
s.add_development_dependency "slim"
4242
s.add_development_dependency "haml"
4343
s.add_development_dependency "redcarpet"
44+
s.add_development_dependency "yard"
4445

4546
if ENV["RELEASING_GEM"].nil? && File.directory?(File.join(__dir__, ".git"))
4647
s.add_runtime_dependency "ruby-next", "~> 1.0"

0 commit comments

Comments
 (0)