jazzy 0.13.5 → 0.14.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.github/workflows/Tests.yml +52 -0
- data/.rubocop.yml +139 -24
- data/CHANGELOG.md +105 -0
- data/CONTRIBUTING.md +5 -5
- data/Dangerfile +11 -8
- data/Gemfile +3 -1
- data/Gemfile.lock +101 -77
- data/README.md +81 -13
- data/Rakefile +13 -12
- data/bin/jazzy +3 -2
- data/bin/sourcekitten +0 -0
- data/jazzy.gemspec +8 -6
- data/js/package-lock.json +30 -25
- data/js/package.json +3 -3
- data/lib/jazzy/config.rb +125 -72
- data/lib/jazzy/doc.rb +3 -1
- data/lib/jazzy/doc_builder.rb +79 -84
- data/lib/jazzy/docset_builder.rb +3 -1
- data/lib/jazzy/documentation_generator.rb +6 -2
- data/lib/jazzy/executable.rb +3 -0
- data/lib/jazzy/extensions/bitbucket/img/bitbucket.svg +11 -0
- data/lib/jazzy/{themes/apple/assets → extensions/github}/img/gh.png +0 -0
- data/lib/jazzy/extensions/gitlab/img/gitlab.svg +23 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_AMS-Regular.ttf +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_AMS-Regular.woff +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_AMS-Regular.woff2 +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Caligraphic-Bold.ttf +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Caligraphic-Bold.woff +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Caligraphic-Bold.woff2 +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Caligraphic-Regular.ttf +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Caligraphic-Regular.woff +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Caligraphic-Regular.woff2 +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Fraktur-Bold.ttf +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Fraktur-Bold.woff +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Fraktur-Bold.woff2 +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Fraktur-Regular.ttf +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Fraktur-Regular.woff +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Fraktur-Regular.woff2 +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Main-Bold.ttf +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Main-Bold.woff +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Main-Bold.woff2 +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Main-BoldItalic.ttf +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Main-BoldItalic.woff +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Main-BoldItalic.woff2 +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Main-Italic.ttf +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Main-Italic.woff +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Main-Italic.woff2 +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Main-Regular.ttf +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Main-Regular.woff +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Main-Regular.woff2 +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Math-BoldItalic.ttf +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Math-BoldItalic.woff +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Math-BoldItalic.woff2 +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Math-Italic.ttf +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Math-Italic.woff +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Math-Italic.woff2 +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_SansSerif-Bold.ttf +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_SansSerif-Bold.woff +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_SansSerif-Bold.woff2 +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_SansSerif-Italic.ttf +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_SansSerif-Italic.woff +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_SansSerif-Italic.woff2 +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_SansSerif-Regular.ttf +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_SansSerif-Regular.woff +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_SansSerif-Regular.woff2 +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Script-Regular.ttf +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Script-Regular.woff +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Script-Regular.woff2 +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Size1-Regular.ttf +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Size1-Regular.woff +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Size1-Regular.woff2 +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Size2-Regular.ttf +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Size2-Regular.woff +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Size2-Regular.woff2 +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Size3-Regular.ttf +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Size3-Regular.woff +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Size3-Regular.woff2 +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Size4-Regular.ttf +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Size4-Regular.woff +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Size4-Regular.woff2 +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Typewriter-Regular.ttf +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Typewriter-Regular.woff +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Typewriter-Regular.woff2 +0 -0
- data/lib/jazzy/extensions/katex/css/katex.min.css +1 -1
- data/lib/jazzy/extensions/katex/js/katex.min.js +1 -1
- data/lib/jazzy/gem_version.rb +3 -1
- data/lib/jazzy/highlighter.rb +17 -3
- data/lib/jazzy/jazzy_markdown.rb +112 -31
- data/lib/jazzy/podspec_documenter.rb +14 -16
- data/lib/jazzy/search_builder.rb +4 -3
- data/lib/jazzy/source_declaration/access_control_level.rb +7 -5
- data/lib/jazzy/source_declaration/type.rb +29 -3
- data/lib/jazzy/source_declaration.rb +18 -3
- data/lib/jazzy/source_document.rb +8 -5
- data/lib/jazzy/source_host.rb +111 -0
- data/lib/jazzy/source_mark.rb +8 -6
- data/lib/jazzy/source_module.rb +6 -6
- data/lib/jazzy/sourcekitten.rb +157 -86
- data/lib/jazzy/stats.rb +14 -3
- data/lib/jazzy/symbol_graph/constraint.rb +98 -0
- data/lib/jazzy/symbol_graph/ext_node.rb +116 -0
- data/lib/jazzy/symbol_graph/graph.rb +200 -0
- data/lib/jazzy/symbol_graph/relationship.rb +48 -0
- data/lib/jazzy/symbol_graph/sym_node.rb +176 -0
- data/lib/jazzy/symbol_graph/symbol.rb +248 -0
- data/lib/jazzy/symbol_graph.rb +95 -0
- data/lib/jazzy/themes/apple/assets/css/highlight.css.scss +63 -59
- data/lib/jazzy/themes/apple/assets/css/jazzy.css.scss +26 -2
- data/lib/jazzy/themes/apple/assets/js/jazzy.js +4 -0
- data/lib/jazzy/themes/apple/assets/js/jazzy.search.js +4 -0
- data/lib/jazzy/themes/apple/assets/js/jquery.min.js +2 -2
- data/lib/jazzy/themes/apple/assets/js/lunr.min.js +3 -3
- data/lib/jazzy/themes/apple/templates/doc.mustache +4 -5
- data/lib/jazzy/themes/apple/templates/footer.mustache +1 -1
- data/lib/jazzy/themes/apple/templates/header.mustache +6 -6
- data/lib/jazzy/themes/apple/templates/task.mustache +6 -11
- data/lib/jazzy/themes/fullwidth/assets/css/highlight.css.scss +63 -59
- data/lib/jazzy/themes/fullwidth/assets/css/jazzy.css.scss +11 -2
- data/lib/jazzy/themes/fullwidth/assets/js/jazzy.js +4 -0
- data/lib/jazzy/themes/fullwidth/assets/js/jazzy.search.js +4 -0
- data/lib/jazzy/themes/fullwidth/assets/js/jquery.min.js +2 -2
- data/lib/jazzy/themes/fullwidth/assets/js/lunr.min.js +3 -3
- data/lib/jazzy/themes/fullwidth/templates/doc.mustache +4 -5
- data/lib/jazzy/themes/fullwidth/templates/footer.mustache +1 -1
- data/lib/jazzy/themes/fullwidth/templates/header.mustache +8 -8
- data/lib/jazzy/themes/fullwidth/templates/task.mustache +6 -11
- data/lib/jazzy/themes/jony/assets/css/highlight.css.scss +63 -59
- data/lib/jazzy/themes/jony/assets/css/jazzy.css.scss +26 -2
- data/lib/jazzy/themes/jony/assets/js/jazzy.js +4 -0
- data/lib/jazzy/themes/jony/assets/js/jquery.min.js +2 -2
- data/lib/jazzy/themes/jony/templates/doc.mustache +4 -5
- data/lib/jazzy/themes/jony/templates/footer.mustache +1 -1
- data/lib/jazzy/themes/jony/templates/header.mustache +6 -6
- data/lib/jazzy/themes/jony/templates/task.mustache +6 -11
- data/lib/jazzy.rb +2 -0
- data/spec/integration_spec.rb +59 -45
- data/spec/spec_helper/pre_flight.rb +2 -0
- data/spec/spec_helper.rb +3 -1
- metadata +39 -19
- data/.circleci/config.yml +0 -83
- data/lib/jazzy/themes/fullwidth/assets/img/gh.png +0 -0
- data/lib/jazzy/themes/jony/assets/img/gh.png +0 -0
- data/spec/sourcekitten_spec.rb +0 -6
data/spec/integration_spec.rb
CHANGED
@@ -1,3 +1,4 @@
|
|
1
|
+
# frozen_string_literal: true
|
1
2
|
|
2
3
|
# ------------------------------------ #
|
3
4
|
# Jazzy Integration tests #
|
@@ -39,7 +40,7 @@
|
|
39
40
|
|
40
41
|
# @return [Pathname] The root of the repo.
|
41
42
|
#
|
42
|
-
ROOT = Pathname.new(File.expand_path('
|
43
|
+
ROOT = Pathname.new(File.expand_path('..', __dir__)) unless defined? ROOT
|
43
44
|
$:.unshift((ROOT + 'spec').to_s)
|
44
45
|
|
45
46
|
require 'rubygems'
|
@@ -98,15 +99,15 @@ describe_cli 'jazzy' do
|
|
98
99
|
subject do |s|
|
99
100
|
s.executable = "ruby #{ROOT + 'bin/jazzy'}"
|
100
101
|
s.environment_vars = {
|
101
|
-
'JAZZY_FAKE_DATE'
|
102
|
-
'JAZZY_FAKE_VERSION'
|
102
|
+
'JAZZY_FAKE_DATE' => 'YYYY-MM-DD',
|
103
|
+
'JAZZY_FAKE_VERSION' => 'X.X.X',
|
103
104
|
'COCOAPODS_SKIP_UPDATE_MESSAGE' => 'TRUE',
|
104
105
|
'JAZZY_INTEGRATION_SPECS' => 'TRUE',
|
105
106
|
'JAZZY_FAKE_MODULE_VERSION' => 'Y.Y.Y',
|
106
107
|
}
|
107
108
|
s.default_args = []
|
108
109
|
s.replace_path ROOT.to_s, 'ROOT'
|
109
|
-
s.replace_pattern /^[\d\s:.-]+ ruby\[\d+:\d+\] warning
|
110
|
+
s.replace_pattern /^[\d\s:.-]+ ruby\[\d+:\d+\] warning:.*$\n?/, ''
|
110
111
|
# Remove version numbers from CocoaPods dependencies
|
111
112
|
# to make specs resilient against dependecy updates.
|
112
113
|
s.replace_pattern(/(Installing \w+ )\((.*)\)/, '\1(X.Y.Z)')
|
@@ -148,19 +149,19 @@ describe_cli 'jazzy' do
|
|
148
149
|
end
|
149
150
|
behaves_like cli_spec 'document_realm_objc',
|
150
151
|
'--objc ' \
|
151
|
-
|
152
|
-
|
153
|
-
|
154
|
-
|
155
|
-
|
156
|
-
|
157
|
-
|
158
|
-
|
159
|
-
|
160
|
-
|
161
|
-
|
162
|
-
|
163
|
-
|
152
|
+
'--author Realm ' \
|
153
|
+
'--author_url "https://realm.io" ' \
|
154
|
+
'--source-host-url ' \
|
155
|
+
'https://github.com/realm/realm-cocoa ' \
|
156
|
+
'--source-host-files-url https://github.com/realm/' \
|
157
|
+
"realm-cocoa/tree/v#{realm_version} " \
|
158
|
+
'--module Realm ' \
|
159
|
+
"--module-version #{realm_version} " \
|
160
|
+
'--root-url https://realm.io/docs/objc/' \
|
161
|
+
"#{realm_version}/api/ " \
|
162
|
+
'--umbrella-header Realm/Realm.h ' \
|
163
|
+
'--framework-root . ' \
|
164
|
+
"--head #{realm_head.shellescape}"
|
164
165
|
end
|
165
166
|
|
166
167
|
describe 'Creates docs for ObjC-Swift project with a variety of contents' do
|
@@ -169,17 +170,17 @@ describe_cli 'jazzy' do
|
|
169
170
|
sourcekitten = ROOT + 'bin/sourcekitten'
|
170
171
|
sdk = `xcrun --show-sdk-path --sdk iphonesimulator`.chomp
|
171
172
|
objc_args = "#{base}/MiscJazzyObjCFeatures/MiscJazzyObjCFeatures.h " \
|
172
|
-
|
173
|
-
|
174
|
-
|
175
|
-
|
173
|
+
'-- -x objective-c ' \
|
174
|
+
"-isysroot #{sdk} " \
|
175
|
+
"-I #{base} " \
|
176
|
+
'-fmodules'
|
176
177
|
`#{sourcekitten} doc --objc #{objc_args} > objc.json`
|
177
|
-
`#{sourcekitten} doc > swift.json`
|
178
|
+
`#{sourcekitten} doc -- clean build > swift.json`
|
178
179
|
end
|
179
180
|
|
180
181
|
behaves_like cli_spec 'misc_jazzy_objc_features',
|
181
182
|
'--theme fullwidth '\
|
182
|
-
|
183
|
+
'-s objc.json,swift.json'
|
183
184
|
end
|
184
185
|
end if !spec_subset || spec_subset == 'objc'
|
185
186
|
|
@@ -187,9 +188,10 @@ describe_cli 'jazzy' do
|
|
187
188
|
describe 'Creates docs with a module name, author name, project URL, ' \
|
188
189
|
'xcodebuild options, and github info' do
|
189
190
|
behaves_like cli_spec 'document_alamofire',
|
190
|
-
'--skip-undocumented'
|
191
|
-
|
192
|
-
|
191
|
+
'--skip-undocumented ' \
|
192
|
+
'--clean ' \
|
193
|
+
'--xcodebuild-arguments ' \
|
194
|
+
"-destination,'platform=OS X'"
|
193
195
|
end
|
194
196
|
|
195
197
|
describe 'Creates Realm Swift docs' do
|
@@ -199,32 +201,42 @@ describe_cli 'jazzy' do
|
|
199
201
|
end
|
200
202
|
behaves_like cli_spec 'document_realm_swift',
|
201
203
|
'--author Realm ' \
|
202
|
-
|
203
|
-
|
204
|
-
|
205
|
-
|
206
|
-
|
207
|
-
|
208
|
-
|
209
|
-
|
210
|
-
|
211
|
-
|
212
|
-
|
213
|
-
|
204
|
+
'--author_url "https://realm.io" ' \
|
205
|
+
'--source-host-url ' \
|
206
|
+
'https://github.com/realm/realm-cocoa ' \
|
207
|
+
'--source-host-files-url https://github.com/realm/' \
|
208
|
+
"realm-cocoa/tree/v#{realm_version} " \
|
209
|
+
'--module RealmSwift ' \
|
210
|
+
"--module-version #{realm_version} " \
|
211
|
+
'--root-url https://realm.io/docs/swift/' \
|
212
|
+
"#{realm_version}/api/ " \
|
213
|
+
'--xcodebuild-arguments ' \
|
214
|
+
'-scheme,RealmSwift,SWIFT_VERSION=4.2,' \
|
215
|
+
"-destination,'platform=OS X' " \
|
216
|
+
"--head #{realm_head.shellescape}"
|
214
217
|
end
|
215
218
|
|
216
219
|
describe 'Creates Siesta docs' do
|
220
|
+
# Siesta already has Docs/
|
221
|
+
# Use the default Swift version rather than the specified 4.0
|
217
222
|
behaves_like cli_spec 'document_siesta',
|
218
|
-
|
219
|
-
|
220
|
-
# Use the default Swift version rather than the
|
221
|
-
# specified 4.0
|
222
|
-
'--swift-version='
|
223
|
+
'--output api-docs ' \
|
224
|
+
'--swift-version= '
|
223
225
|
end
|
224
226
|
|
225
227
|
describe 'Creates docs for Swift project with a variety of contents' do
|
226
|
-
behaves_like cli_spec 'misc_jazzy_features'
|
227
|
-
|
228
|
+
behaves_like cli_spec 'misc_jazzy_features'
|
229
|
+
end
|
230
|
+
|
231
|
+
describe 'Creates docs for Swift project from a .swiftmodule' do
|
232
|
+
build_path = Dir.getwd + 'tmp/.build'
|
233
|
+
package_path =
|
234
|
+
ROOT + 'spec/integration_specs/misc_jazzy_symgraph_features/before'
|
235
|
+
`swift build --package-path #{package_path} --build-path #{build_path}`
|
236
|
+
module_path = `swift build --build-path #{build_path} --show-bin-path`
|
237
|
+
behaves_like cli_spec 'misc_jazzy_symgraph_features',
|
238
|
+
'--swift-build-tool symbolgraph ' \
|
239
|
+
"--build-tool-arguments -I,#{module_path} "
|
228
240
|
end
|
229
241
|
end if !spec_subset || spec_subset == 'swift'
|
230
242
|
|
@@ -235,4 +247,6 @@ describe_cli 'jazzy' do
|
|
235
247
|
'--podspec=Moya.podspec'
|
236
248
|
end
|
237
249
|
end if !spec_subset || spec_subset == 'cocoapods'
|
250
|
+
|
251
|
+
# rubocop:enable Style/MultilineIfModifier
|
238
252
|
end
|
data/spec/spec_helper.rb
CHANGED
@@ -1,3 +1,5 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
require 'rubygems'
|
2
4
|
require 'bundler/setup'
|
3
5
|
require 'bacon'
|
@@ -5,7 +7,7 @@ require 'mocha-on-bacon'
|
|
5
7
|
require 'pretty_bacon'
|
6
8
|
require 'pathname'
|
7
9
|
|
8
|
-
ROOT = Pathname.new(File.expand_path('
|
10
|
+
ROOT = Pathname.new(File.expand_path('..', __dir__))
|
9
11
|
$LOAD_PATH.unshift((ROOT + 'lib').to_s)
|
10
12
|
$LOAD_PATH.unshift((ROOT + 'spec').to_s)
|
11
13
|
|
metadata
CHANGED
@@ -1,17 +1,17 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: jazzy
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.14.1
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- JP Simard
|
8
8
|
- Tim Anglade
|
9
9
|
- Samuel Giddins
|
10
10
|
- John Fairhurst
|
11
|
-
autorequire:
|
11
|
+
autorequire:
|
12
12
|
bindir: bin
|
13
13
|
cert_chain: []
|
14
|
-
date:
|
14
|
+
date: 2021-10-02 00:00:00.000000000 Z
|
15
15
|
dependencies:
|
16
16
|
- !ruby/object:Gem::Dependency
|
17
17
|
name: cocoapods
|
@@ -45,16 +45,16 @@ dependencies:
|
|
45
45
|
name: open4
|
46
46
|
requirement: !ruby/object:Gem::Requirement
|
47
47
|
requirements:
|
48
|
-
- - "
|
48
|
+
- - "~>"
|
49
49
|
- !ruby/object:Gem::Version
|
50
|
-
version: '
|
50
|
+
version: '1.3'
|
51
51
|
type: :runtime
|
52
52
|
prerelease: false
|
53
53
|
version_requirements: !ruby/object:Gem::Requirement
|
54
54
|
requirements:
|
55
|
-
- - "
|
55
|
+
- - "~>"
|
56
56
|
- !ruby/object:Gem::Version
|
57
|
-
version: '
|
57
|
+
version: '1.3'
|
58
58
|
- !ruby/object:Gem::Dependency
|
59
59
|
name: redcarpet
|
60
60
|
requirement: !ruby/object:Gem::Requirement
|
@@ -69,6 +69,20 @@ dependencies:
|
|
69
69
|
- - "~>"
|
70
70
|
- !ruby/object:Gem::Version
|
71
71
|
version: '3.4'
|
72
|
+
- !ruby/object:Gem::Dependency
|
73
|
+
name: rexml
|
74
|
+
requirement: !ruby/object:Gem::Requirement
|
75
|
+
requirements:
|
76
|
+
- - "~>"
|
77
|
+
- !ruby/object:Gem::Version
|
78
|
+
version: '3.2'
|
79
|
+
type: :runtime
|
80
|
+
prerelease: false
|
81
|
+
version_requirements: !ruby/object:Gem::Requirement
|
82
|
+
requirements:
|
83
|
+
- - "~>"
|
84
|
+
- !ruby/object:Gem::Version
|
85
|
+
version: '3.2'
|
72
86
|
- !ruby/object:Gem::Dependency
|
73
87
|
name: rouge
|
74
88
|
requirement: !ruby/object:Gem::Requirement
|
@@ -137,14 +151,14 @@ dependencies:
|
|
137
151
|
requirements:
|
138
152
|
- - "~>"
|
139
153
|
- !ruby/object:Gem::Version
|
140
|
-
version: '1
|
154
|
+
version: '2.1'
|
141
155
|
type: :development
|
142
156
|
prerelease: false
|
143
157
|
version_requirements: !ruby/object:Gem::Requirement
|
144
158
|
requirements:
|
145
159
|
- - "~>"
|
146
160
|
- !ruby/object:Gem::Version
|
147
|
-
version: '1
|
161
|
+
version: '2.1'
|
148
162
|
- !ruby/object:Gem::Dependency
|
149
163
|
name: rake
|
150
164
|
requirement: !ruby/object:Gem::Requirement
|
@@ -168,7 +182,7 @@ executables:
|
|
168
182
|
extensions: []
|
169
183
|
extra_rdoc_files: []
|
170
184
|
files:
|
171
|
-
- ".
|
185
|
+
- ".github/workflows/Tests.yml"
|
172
186
|
- ".gitignore"
|
173
187
|
- ".gitmodules"
|
174
188
|
- ".rubocop.yml"
|
@@ -198,6 +212,9 @@ files:
|
|
198
212
|
- lib/jazzy/docset_builder/info_plist.mustache
|
199
213
|
- lib/jazzy/documentation_generator.rb
|
200
214
|
- lib/jazzy/executable.rb
|
215
|
+
- lib/jazzy/extensions/bitbucket/img/bitbucket.svg
|
216
|
+
- lib/jazzy/extensions/github/img/gh.png
|
217
|
+
- lib/jazzy/extensions/gitlab/img/gitlab.svg
|
201
218
|
- lib/jazzy/extensions/katex/css/fonts/KaTeX_AMS-Regular.ttf
|
202
219
|
- lib/jazzy/extensions/katex/css/fonts/KaTeX_AMS-Regular.woff
|
203
220
|
- lib/jazzy/extensions/katex/css/fonts/KaTeX_AMS-Regular.woff2
|
@@ -269,15 +286,22 @@ files:
|
|
269
286
|
- lib/jazzy/source_declaration/access_control_level.rb
|
270
287
|
- lib/jazzy/source_declaration/type.rb
|
271
288
|
- lib/jazzy/source_document.rb
|
289
|
+
- lib/jazzy/source_host.rb
|
272
290
|
- lib/jazzy/source_mark.rb
|
273
291
|
- lib/jazzy/source_module.rb
|
274
292
|
- lib/jazzy/sourcekitten.rb
|
275
293
|
- lib/jazzy/stats.rb
|
294
|
+
- lib/jazzy/symbol_graph.rb
|
295
|
+
- lib/jazzy/symbol_graph/constraint.rb
|
296
|
+
- lib/jazzy/symbol_graph/ext_node.rb
|
297
|
+
- lib/jazzy/symbol_graph/graph.rb
|
298
|
+
- lib/jazzy/symbol_graph/relationship.rb
|
299
|
+
- lib/jazzy/symbol_graph/sym_node.rb
|
300
|
+
- lib/jazzy/symbol_graph/symbol.rb
|
276
301
|
- lib/jazzy/themes/apple/assets/css/highlight.css.scss
|
277
302
|
- lib/jazzy/themes/apple/assets/css/jazzy.css.scss
|
278
303
|
- lib/jazzy/themes/apple/assets/img/carat.png
|
279
304
|
- lib/jazzy/themes/apple/assets/img/dash.png
|
280
|
-
- lib/jazzy/themes/apple/assets/img/gh.png
|
281
305
|
- lib/jazzy/themes/apple/assets/img/spinner.gif
|
282
306
|
- lib/jazzy/themes/apple/assets/js/jazzy.js
|
283
307
|
- lib/jazzy/themes/apple/assets/js/jazzy.search.js
|
@@ -296,7 +320,6 @@ files:
|
|
296
320
|
- lib/jazzy/themes/fullwidth/assets/css/jazzy.css.scss
|
297
321
|
- lib/jazzy/themes/fullwidth/assets/img/carat.png
|
298
322
|
- lib/jazzy/themes/fullwidth/assets/img/dash.png
|
299
|
-
- lib/jazzy/themes/fullwidth/assets/img/gh.png
|
300
323
|
- lib/jazzy/themes/fullwidth/assets/img/spinner.gif
|
301
324
|
- lib/jazzy/themes/fullwidth/assets/js/jazzy.js
|
302
325
|
- lib/jazzy/themes/fullwidth/assets/js/jazzy.search.js
|
@@ -315,7 +338,6 @@ files:
|
|
315
338
|
- lib/jazzy/themes/jony/assets/css/jazzy.css.scss
|
316
339
|
- lib/jazzy/themes/jony/assets/img/carat.png
|
317
340
|
- lib/jazzy/themes/jony/assets/img/dash.png
|
318
|
-
- lib/jazzy/themes/jony/assets/img/gh.png
|
319
341
|
- lib/jazzy/themes/jony/assets/js/jazzy.js
|
320
342
|
- lib/jazzy/themes/jony/assets/js/jquery.min.js
|
321
343
|
- lib/jazzy/themes/jony/templates/deprecation.mustache
|
@@ -327,14 +349,13 @@ files:
|
|
327
349
|
- lib/jazzy/themes/jony/templates/task.mustache
|
328
350
|
- lib/jazzy/themes/jony/templates/tasks.mustache
|
329
351
|
- spec/integration_spec.rb
|
330
|
-
- spec/sourcekitten_spec.rb
|
331
352
|
- spec/spec_helper.rb
|
332
353
|
- spec/spec_helper/pre_flight.rb
|
333
354
|
homepage: https://github.com/realm/jazzy
|
334
355
|
licenses:
|
335
356
|
- MIT
|
336
357
|
metadata: {}
|
337
|
-
post_install_message:
|
358
|
+
post_install_message:
|
338
359
|
rdoc_options: []
|
339
360
|
require_paths:
|
340
361
|
- lib
|
@@ -342,16 +363,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
342
363
|
requirements:
|
343
364
|
- - ">="
|
344
365
|
- !ruby/object:Gem::Version
|
345
|
-
version: 2.
|
366
|
+
version: 2.6.3
|
346
367
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
347
368
|
requirements:
|
348
369
|
- - ">="
|
349
370
|
- !ruby/object:Gem::Version
|
350
371
|
version: '0'
|
351
372
|
requirements: []
|
352
|
-
|
353
|
-
|
354
|
-
signing_key:
|
373
|
+
rubygems_version: 3.1.4
|
374
|
+
signing_key:
|
355
375
|
specification_version: 4
|
356
376
|
summary: Soulful docs for Swift & Objective-C.
|
357
377
|
test_files: []
|
data/.circleci/config.yml
DELETED
@@ -1,83 +0,0 @@
|
|
1
|
-
aliases:
|
2
|
-
- &save-mac-bundler-cache
|
3
|
-
key: bundle_mac
|
4
|
-
paths:
|
5
|
-
- vendor/bundle
|
6
|
-
|
7
|
-
- &restore-mac-bundler-cache
|
8
|
-
key: bundle_mac
|
9
|
-
|
10
|
-
- &bundler-environment
|
11
|
-
BUNDLE_JOBS: 3
|
12
|
-
BUNDLE_RETRY: 3
|
13
|
-
BUNDLE_PATH: vendor/bundle
|
14
|
-
|
15
|
-
version: 2
|
16
|
-
jobs:
|
17
|
-
|
18
|
-
swift:
|
19
|
-
macos:
|
20
|
-
xcode: "11.4.0"
|
21
|
-
environment: *bundler-environment
|
22
|
-
steps:
|
23
|
-
- checkout
|
24
|
-
- restore_cache: *restore-mac-bundler-cache
|
25
|
-
- run: bundle install
|
26
|
-
- run: git submodule update --init --recursive
|
27
|
-
- run: bundle exec rake swift_spec
|
28
|
-
- save_cache: *save-mac-bundler-cache
|
29
|
-
|
30
|
-
objc:
|
31
|
-
macos:
|
32
|
-
xcode: "11.4.0"
|
33
|
-
environment: *bundler-environment
|
34
|
-
steps:
|
35
|
-
- checkout
|
36
|
-
- restore_cache: *restore-mac-bundler-cache
|
37
|
-
- run: bundle install
|
38
|
-
- run: git submodule update --init --recursive
|
39
|
-
- run: bundle exec rake objc_spec
|
40
|
-
- save_cache: *save-mac-bundler-cache
|
41
|
-
|
42
|
-
cocoapods:
|
43
|
-
macos:
|
44
|
-
xcode: "11.4.0"
|
45
|
-
environment: *bundler-environment
|
46
|
-
steps:
|
47
|
-
- checkout
|
48
|
-
- restore_cache:
|
49
|
-
key: cocoapods
|
50
|
-
- restore_cache: *restore-mac-bundler-cache
|
51
|
-
- run: bundle install
|
52
|
-
- run: git submodule update --init --recursive
|
53
|
-
- run: bundle exec rake cocoapods_spec
|
54
|
-
- save_cache:
|
55
|
-
key: cocoapods
|
56
|
-
paths:
|
57
|
-
- ~/.cocoapods
|
58
|
-
- save_cache: *save-mac-bundler-cache
|
59
|
-
|
60
|
-
danger_and_rubocop:
|
61
|
-
docker:
|
62
|
-
- image: circleci/ruby:2.4-node
|
63
|
-
environment: *bundler-environment
|
64
|
-
steps:
|
65
|
-
- checkout
|
66
|
-
- restore_cache:
|
67
|
-
key: bundle_linux
|
68
|
-
- run: bundle install
|
69
|
-
- run: bundle exec danger --verbose || true
|
70
|
-
- run: bundle exec rake rubocop
|
71
|
-
- save_cache:
|
72
|
-
key: bundle_linux
|
73
|
-
paths:
|
74
|
-
- vendor/bundle
|
75
|
-
|
76
|
-
workflows:
|
77
|
-
version: 2
|
78
|
-
workflow:
|
79
|
-
jobs:
|
80
|
-
- swift
|
81
|
-
- objc
|
82
|
-
- cocoapods
|
83
|
-
- danger_and_rubocop
|
Binary file
|
Binary file
|