Skip to content

Commit feb2f8a

Browse files
vinistockst0012
andauthored
Use Snapper generator for RDoc documentation (#1384)
Co-authored-by: Stan Lo <[email protected]>
1 parent 64b63bb commit feb2f8a

File tree

3 files changed

+11
-4
lines changed

3 files changed

+11
-4
lines changed

Gemfile

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ group :development do
1212
gem "mocha", "~> 2.1"
1313
gem "psych", "~> 5.1", require: false
1414
gem "rake", "~> 13.1"
15-
gem "rdoc", require: false
15+
gem "rdoc", require: false, github: "Shopify/rdoc", branch: "create_snapper_generator"
1616
gem "rubocop-minitest", "~> 0.34.5", require: false
1717
gem "rubocop-rake", "~> 0.6.0", require: false
1818
gem "rubocop-shopify", "~> 2.14", require: false

Gemfile.lock

+9-3
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1+
GIT
2+
remote: https://github.com/Shopify/rdoc.git
3+
revision: 360dd09cdd025278e3f8156ca895395325f54d7b
4+
branch: create_snapper_generator
5+
specs:
6+
rdoc (6.6.2)
7+
psych (>= 4.0.0)
8+
19
PATH
210
remote: .
311
specs:
@@ -45,8 +53,6 @@ GEM
4553
rbi (0.1.8)
4654
prism (>= 0.18.0, < 0.22)
4755
sorbet-runtime (>= 0.5.9204)
48-
rdoc (6.6.2)
49-
psych (>= 4.0.0)
5056
regexp_parser (2.9.0)
5157
reline (0.4.1)
5258
io-console (~> 0.5)
@@ -122,7 +128,7 @@ DEPENDENCIES
122128
mocha (~> 2.1)
123129
psych (~> 5.1)
124130
rake (~> 13.1)
125-
rdoc
131+
rdoc!
126132
rubocop (~> 1.60)
127133
rubocop-minitest (~> 0.34.5)
128134
rubocop-rake (~> 0.6.0)

Rakefile

+1
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ RDoc::Task.new do |rdoc|
1717
rdoc.rdoc_files.include("*.md", "lib/**/*.rb")
1818
rdoc.rdoc_dir = "docs"
1919
rdoc.markup = "markdown"
20+
rdoc.generator = "snapper"
2021
rdoc.options.push("--copy-files", "misc")
2122
rdoc.options.push("--copy-files", "LICENSE.txt")
2223
end

0 commit comments

Comments
 (0)