Skip to content

Commit 13c5147

Browse files
committed
➕ commonmarker for yard
- ref: lsegal/yard#1587
1 parent 4133646 commit 13c5147

File tree

3 files changed

+9
-1
lines changed

3 files changed

+9
-1
lines changed

Gemfile

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@ gem "uri", "~> 0.13", ">= 0.13.1"
2020
gem "logger", "~> 1.6", ">= 1.6.1"
2121
gem "rexml", "~> 3.3", ">= 3.3.7"
2222

23+
gem "commonmarker", "~> 1.1", ">= 1.1.5" # Ruby >= 3.1
24+
2325
# Specify your gem's dependencies in ruby-openid.gemspec
2426
gemspec
2527

Gemfile.lock

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ GEM
1111
ast (2.4.2)
1212
backports (3.25.0)
1313
byebug (11.1.3)
14+
commonmarker (1.1.5-arm64-darwin)
1415
diff-lcs (1.5.1)
1516
diffy (3.4.2)
1617
docile (1.4.1)
@@ -142,6 +143,7 @@ PLATFORMS
142143

143144
DEPENDENCIES
144145
byebug (>= 11)
146+
commonmarker (~> 1.1, >= 1.1.5)
145147
kettle-soup-cover (~> 1.0, >= 1.0.2)
146148
logger (~> 1.6, >= 1.6.1)
147149
minitest (>= 5, < 6)

Rakefile

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,11 @@ end
3333
begin
3434
require "yard"
3535

36-
YARD::Rake::YardocTask.new(:yard)
36+
YARD::Rake::YardocTask.new do |t|
37+
t.files = ["lib/**/*.rb"]
38+
t.options = ["--debug", "--markup", "markdown", "--markup-provider", "commonmarker"]
39+
t.stats_options = ["--list-undoc"] if ENV.fetch("VERBOSE", "false").casecmp?("true")
40+
end
3741
rescue LoadError
3842
task(:yard) do
3943
warn("yard is disabled")

0 commit comments

Comments
 (0)