jazzy 0.9.3 → 0.9.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.circleci/config.yml +3 -3
- data/CHANGELOG.md +52 -0
- data/CONTRIBUTING.md +1 -1
- data/Gemfile.lock +44 -44
- data/README.md +44 -6
- data/bin/sourcekitten +0 -0
- data/jazzy.gemspec +5 -5
- data/lib/jazzy/config.rb +8 -3
- data/lib/jazzy/doc_builder.rb +12 -4
- data/lib/jazzy/documentation_generator.rb +0 -7
- data/lib/jazzy/gem_version.rb +1 -1
- data/lib/jazzy/podspec_documenter.rb +19 -2
- data/lib/jazzy/source_declaration.rb +15 -4
- data/lib/jazzy/source_declaration/type.rb +11 -1
- data/lib/jazzy/source_document.rb +18 -2
- data/lib/jazzy/sourcekitten.rb +41 -17
- data/lib/jazzy/themes/apple/assets/css/jazzy.css.scss +9 -5
- data/lib/jazzy/themes/apple/templates/deprecation.mustache +12 -0
- data/lib/jazzy/themes/apple/templates/doc.mustache +1 -0
- data/lib/jazzy/themes/apple/templates/task.mustache +12 -0
- data/lib/jazzy/themes/fullwidth/assets/css/jazzy.css.scss +10 -4
- data/lib/jazzy/themes/fullwidth/assets/js/jazzy.search.js +2 -1
- data/lib/jazzy/themes/fullwidth/templates/deprecation.mustache +12 -0
- data/lib/jazzy/themes/fullwidth/templates/doc.mustache +1 -0
- data/lib/jazzy/themes/fullwidth/templates/task.mustache +12 -0
- data/lib/jazzy/themes/jony/assets/css/jazzy.css.scss +5 -2
- data/lib/jazzy/themes/jony/templates/deprecation.mustache +12 -0
- data/lib/jazzy/themes/jony/templates/doc.mustache +1 -0
- data/lib/jazzy/themes/jony/templates/task.mustache +12 -0
- data/spec/integration_spec.rb +1 -1
- metadata +16 -14
- data/lib/jazzy/readme_generator.rb +0 -61
|
@@ -2,6 +2,7 @@ $(function(){
|
|
|
2
2
|
var searchIndex = lunr(function() {
|
|
3
3
|
this.ref('url');
|
|
4
4
|
this.field('name');
|
|
5
|
+
this.field('abstract');
|
|
5
6
|
});
|
|
6
7
|
|
|
7
8
|
var $typeahead = $('[data-typeahead]');
|
|
@@ -27,7 +28,7 @@ $(function(){
|
|
|
27
28
|
|
|
28
29
|
$.getJSON(searchURL).then(function(searchData) {
|
|
29
30
|
$.each(searchData, function (url, doc) {
|
|
30
|
-
searchIndex.add({url: url, name: doc.name});
|
|
31
|
+
searchIndex.add({url: url, name: doc.name, abstract: doc.abstract});
|
|
31
32
|
});
|
|
32
33
|
|
|
33
34
|
$typeahead.typeahead(
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
{{#deprecation_message}}
|
|
2
|
+
<div class="aside aside-deprecated">
|
|
3
|
+
<p class="aside-title">Deprecated</p>
|
|
4
|
+
{{{deprecation_message}}}
|
|
5
|
+
</div>
|
|
6
|
+
{{/deprecation_message}}
|
|
7
|
+
{{#unavailable_message}}
|
|
8
|
+
<div class="aside aside-unavailable">
|
|
9
|
+
<p class="aside-title">Unavailable</p>
|
|
10
|
+
{{{unavailable_message}}}
|
|
11
|
+
</div>
|
|
12
|
+
{{/unavailable_message}}
|
|
@@ -15,7 +15,17 @@
|
|
|
15
15
|
<code>
|
|
16
16
|
<a name="/{{usr}}"></a>
|
|
17
17
|
<a name="//apple_ref/{{language_stub}}/{{dash_type}}/{{name}}" class="dashAnchor"></a>
|
|
18
|
+
{{#direct_link}}
|
|
19
|
+
<a class="direct-link" href="{{url}}">{{name}}</a>
|
|
20
|
+
</code>
|
|
21
|
+
{{/direct_link}}
|
|
22
|
+
{{^direct_link}}
|
|
23
|
+
{{^usage_discouraged}}
|
|
18
24
|
<a class="token" href="#/{{usr}}">{{name}}</a>
|
|
25
|
+
{{/usage_discouraged}}
|
|
26
|
+
{{#usage_discouraged}}
|
|
27
|
+
<a class="token discouraged" href="#/{{usr}}">{{name}}</a>
|
|
28
|
+
{{/usage_discouraged}}
|
|
19
29
|
</code>
|
|
20
30
|
{{#default_impl_abstract}}
|
|
21
31
|
<span class="declaration-note">
|
|
@@ -32,6 +42,7 @@
|
|
|
32
42
|
<div class="pointer-container"></div>
|
|
33
43
|
<section class="section">
|
|
34
44
|
<div class="pointer"></div>
|
|
45
|
+
{{> deprecation}}
|
|
35
46
|
{{#abstract}}
|
|
36
47
|
<div class="abstract">
|
|
37
48
|
{{{abstract}}}
|
|
@@ -85,6 +96,7 @@
|
|
|
85
96
|
</div>
|
|
86
97
|
{{/github_token_url}}
|
|
87
98
|
</section>
|
|
99
|
+
{{/direct_link}}
|
|
88
100
|
</div>
|
|
89
101
|
</li>
|
|
90
102
|
{{/items}}
|
|
@@ -372,10 +372,13 @@ header {
|
|
|
372
372
|
background-color: transparent;
|
|
373
373
|
padding: 0;
|
|
374
374
|
}
|
|
375
|
-
.token {
|
|
375
|
+
.token, .direct-link {
|
|
376
376
|
padding-left: 3px;
|
|
377
377
|
margin-left: 35px;
|
|
378
378
|
}
|
|
379
|
+
.discouraged {
|
|
380
|
+
text-decoration: line-through;
|
|
381
|
+
}
|
|
379
382
|
.declaration-note {
|
|
380
383
|
font-size: .85em;
|
|
381
384
|
color: rgba(128,128,128,1);
|
|
@@ -448,7 +451,7 @@ header {
|
|
|
448
451
|
}
|
|
449
452
|
}
|
|
450
453
|
|
|
451
|
-
.aside-warning {
|
|
454
|
+
.aside-warning, .aside-deprecated, .aside-unavailable {
|
|
452
455
|
border-left: $aside_warning_border;
|
|
453
456
|
.aside-title {
|
|
454
457
|
color: $aside_warning_color;
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
{{#deprecation_message}}
|
|
2
|
+
<div class="aside aside-deprecated">
|
|
3
|
+
<p class="aside-title">Deprecated</p>
|
|
4
|
+
{{{deprecation_message}}}
|
|
5
|
+
</div>
|
|
6
|
+
{{/deprecation_message}}
|
|
7
|
+
{{#unavailable_message}}
|
|
8
|
+
<div class="aside aside-unavailable">
|
|
9
|
+
<p class="aside-title">Unavailable</p>
|
|
10
|
+
{{{unavailable_message}}}
|
|
11
|
+
</div>
|
|
12
|
+
{{/unavailable_message}}
|
|
@@ -15,7 +15,17 @@
|
|
|
15
15
|
<code>
|
|
16
16
|
<a name="/{{usr}}"></a>
|
|
17
17
|
<a name="//apple_ref/{{language_stub}}/{{dash_type}}/{{name}}" class="dashAnchor"></a>
|
|
18
|
+
{{#direct_link}}
|
|
19
|
+
<a class="direct-link" href="{{url}}">{{name}}</a>
|
|
20
|
+
</code>
|
|
21
|
+
{{/direct_link}}
|
|
22
|
+
{{^direct_link}}
|
|
23
|
+
{{^usage_discouraged}}
|
|
18
24
|
<a class="token" href="#/{{usr}}">{{name}}</a>
|
|
25
|
+
{{/usage_discouraged}}
|
|
26
|
+
{{#usage_discouraged}}
|
|
27
|
+
<a class="token discouraged" href="#/{{usr}}">{{name}}</a>
|
|
28
|
+
{{/usage_discouraged}}
|
|
19
29
|
</code>
|
|
20
30
|
{{#default_impl_abstract}}
|
|
21
31
|
<span class="declaration-note">
|
|
@@ -32,6 +42,7 @@
|
|
|
32
42
|
<div class="pointer-container"></div>
|
|
33
43
|
<section class="section">
|
|
34
44
|
<div class="pointer"></div>
|
|
45
|
+
{{> deprecation}}
|
|
35
46
|
{{#abstract}}
|
|
36
47
|
<div class="abstract">
|
|
37
48
|
{{{abstract}}}
|
|
@@ -85,6 +96,7 @@
|
|
|
85
96
|
</div>
|
|
86
97
|
{{/github_token_url}}
|
|
87
98
|
</section>
|
|
99
|
+
{{/direct_link}}
|
|
88
100
|
</div>
|
|
89
101
|
</li>
|
|
90
102
|
{{/items}}
|
data/spec/integration_spec.rb
CHANGED
|
@@ -175,7 +175,7 @@ describe_cli 'jazzy' do
|
|
|
175
175
|
behaves_like cli_spec 'document_alamofire',
|
|
176
176
|
'-m Alamofire -a Alamofire ' \
|
|
177
177
|
'-u https://nshipster.com/alamofire ' \
|
|
178
|
-
'-x -project,Alamofire.xcodeproj
|
|
178
|
+
'-x -project,Alamofire.xcodeproj ' \
|
|
179
179
|
'-g https://github.com/Alamofire/Alamofire ' \
|
|
180
180
|
'--github-file-prefix https://github.com/' \
|
|
181
181
|
'Alamofire/Alamofire/blob/4.3.0 ' \
|
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: jazzy
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.9.
|
|
4
|
+
version: 0.9.5
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- JP Simard
|
|
@@ -10,7 +10,7 @@ authors:
|
|
|
10
10
|
autorequire:
|
|
11
11
|
bindir: bin
|
|
12
12
|
cert_chain: []
|
|
13
|
-
date:
|
|
13
|
+
date: 2019-01-26 00:00:00.000000000 Z
|
|
14
14
|
dependencies:
|
|
15
15
|
- !ruby/object:Gem::Dependency
|
|
16
16
|
name: cocoapods
|
|
@@ -18,28 +18,28 @@ dependencies:
|
|
|
18
18
|
requirements:
|
|
19
19
|
- - "~>"
|
|
20
20
|
- !ruby/object:Gem::Version
|
|
21
|
-
version:
|
|
21
|
+
version: 1.5.3
|
|
22
22
|
type: :runtime
|
|
23
23
|
prerelease: false
|
|
24
24
|
version_requirements: !ruby/object:Gem::Requirement
|
|
25
25
|
requirements:
|
|
26
26
|
- - "~>"
|
|
27
27
|
- !ruby/object:Gem::Version
|
|
28
|
-
version:
|
|
28
|
+
version: 1.5.3
|
|
29
29
|
- !ruby/object:Gem::Dependency
|
|
30
30
|
name: mustache
|
|
31
31
|
requirement: !ruby/object:Gem::Requirement
|
|
32
32
|
requirements:
|
|
33
33
|
- - "~>"
|
|
34
34
|
- !ruby/object:Gem::Version
|
|
35
|
-
version:
|
|
35
|
+
version: 1.1.0
|
|
36
36
|
type: :runtime
|
|
37
37
|
prerelease: false
|
|
38
38
|
version_requirements: !ruby/object:Gem::Requirement
|
|
39
39
|
requirements:
|
|
40
40
|
- - "~>"
|
|
41
41
|
- !ruby/object:Gem::Version
|
|
42
|
-
version:
|
|
42
|
+
version: 1.1.0
|
|
43
43
|
- !ruby/object:Gem::Dependency
|
|
44
44
|
name: open4
|
|
45
45
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -60,14 +60,14 @@ dependencies:
|
|
|
60
60
|
requirements:
|
|
61
61
|
- - "~>"
|
|
62
62
|
- !ruby/object:Gem::Version
|
|
63
|
-
version:
|
|
63
|
+
version: 3.4.0
|
|
64
64
|
type: :runtime
|
|
65
65
|
prerelease: false
|
|
66
66
|
version_requirements: !ruby/object:Gem::Requirement
|
|
67
67
|
requirements:
|
|
68
68
|
- - "~>"
|
|
69
69
|
- !ruby/object:Gem::Version
|
|
70
|
-
version:
|
|
70
|
+
version: 3.4.0
|
|
71
71
|
- !ruby/object:Gem::Dependency
|
|
72
72
|
name: rouge
|
|
73
73
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -94,28 +94,28 @@ dependencies:
|
|
|
94
94
|
requirements:
|
|
95
95
|
- - "~>"
|
|
96
96
|
- !ruby/object:Gem::Version
|
|
97
|
-
version:
|
|
97
|
+
version: 3.6.0
|
|
98
98
|
type: :runtime
|
|
99
99
|
prerelease: false
|
|
100
100
|
version_requirements: !ruby/object:Gem::Requirement
|
|
101
101
|
requirements:
|
|
102
102
|
- - "~>"
|
|
103
103
|
- !ruby/object:Gem::Version
|
|
104
|
-
version:
|
|
104
|
+
version: 3.6.0
|
|
105
105
|
- !ruby/object:Gem::Dependency
|
|
106
106
|
name: sqlite3
|
|
107
107
|
requirement: !ruby/object:Gem::Requirement
|
|
108
108
|
requirements:
|
|
109
109
|
- - "~>"
|
|
110
110
|
- !ruby/object:Gem::Version
|
|
111
|
-
version:
|
|
111
|
+
version: 1.3.13
|
|
112
112
|
type: :runtime
|
|
113
113
|
prerelease: false
|
|
114
114
|
version_requirements: !ruby/object:Gem::Requirement
|
|
115
115
|
requirements:
|
|
116
116
|
- - "~>"
|
|
117
117
|
- !ruby/object:Gem::Version
|
|
118
|
-
version:
|
|
118
|
+
version: 1.3.13
|
|
119
119
|
- !ruby/object:Gem::Dependency
|
|
120
120
|
name: xcinvoke
|
|
121
121
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -198,7 +198,6 @@ files:
|
|
|
198
198
|
- lib/jazzy/highlighter.rb
|
|
199
199
|
- lib/jazzy/jazzy_markdown.rb
|
|
200
200
|
- lib/jazzy/podspec_documenter.rb
|
|
201
|
-
- lib/jazzy/readme_generator.rb
|
|
202
201
|
- lib/jazzy/search_builder.rb
|
|
203
202
|
- lib/jazzy/source_declaration.rb
|
|
204
203
|
- lib/jazzy/source_declaration/access_control_level.rb
|
|
@@ -215,6 +214,7 @@ files:
|
|
|
215
214
|
- lib/jazzy/themes/apple/assets/img/gh.png
|
|
216
215
|
- lib/jazzy/themes/apple/assets/js/jazzy.js
|
|
217
216
|
- lib/jazzy/themes/apple/assets/js/jquery.min.js
|
|
217
|
+
- lib/jazzy/themes/apple/templates/deprecation.mustache
|
|
218
218
|
- lib/jazzy/themes/apple/templates/doc.mustache
|
|
219
219
|
- lib/jazzy/themes/apple/templates/footer.mustache
|
|
220
220
|
- lib/jazzy/themes/apple/templates/header.mustache
|
|
@@ -233,6 +233,7 @@ files:
|
|
|
233
233
|
- lib/jazzy/themes/fullwidth/assets/js/jquery.min.js
|
|
234
234
|
- lib/jazzy/themes/fullwidth/assets/js/lunr.min.js
|
|
235
235
|
- lib/jazzy/themes/fullwidth/assets/js/typeahead.jquery.js
|
|
236
|
+
- lib/jazzy/themes/fullwidth/templates/deprecation.mustache
|
|
236
237
|
- lib/jazzy/themes/fullwidth/templates/doc.mustache
|
|
237
238
|
- lib/jazzy/themes/fullwidth/templates/footer.mustache
|
|
238
239
|
- lib/jazzy/themes/fullwidth/templates/header.mustache
|
|
@@ -247,6 +248,7 @@ files:
|
|
|
247
248
|
- lib/jazzy/themes/jony/assets/img/gh.png
|
|
248
249
|
- lib/jazzy/themes/jony/assets/js/jazzy.js
|
|
249
250
|
- lib/jazzy/themes/jony/assets/js/jquery.min.js
|
|
251
|
+
- lib/jazzy/themes/jony/templates/deprecation.mustache
|
|
250
252
|
- lib/jazzy/themes/jony/templates/doc.mustache
|
|
251
253
|
- lib/jazzy/themes/jony/templates/footer.mustache
|
|
252
254
|
- lib/jazzy/themes/jony/templates/header.mustache
|
|
@@ -278,7 +280,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
278
280
|
version: '0'
|
|
279
281
|
requirements: []
|
|
280
282
|
rubyforge_project:
|
|
281
|
-
rubygems_version: 2.
|
|
283
|
+
rubygems_version: 2.4.5
|
|
282
284
|
signing_key:
|
|
283
285
|
specification_version: 4
|
|
284
286
|
summary: Soulful docs for Swift & Objective-C.
|
|
@@ -1,61 +0,0 @@
|
|
|
1
|
-
require 'pathname'
|
|
2
|
-
|
|
3
|
-
require 'jazzy/jazzy_markdown'
|
|
4
|
-
|
|
5
|
-
module Jazzy
|
|
6
|
-
module ReadmeGenerator
|
|
7
|
-
extend Config::Mixin
|
|
8
|
-
|
|
9
|
-
def self.generate(source_module)
|
|
10
|
-
readme = readme_path
|
|
11
|
-
|
|
12
|
-
unless readme && readme.exist? && readme = readme.read
|
|
13
|
-
readme = generated_readme(source_module)
|
|
14
|
-
end
|
|
15
|
-
|
|
16
|
-
Jazzy.markdown.render(readme)
|
|
17
|
-
end
|
|
18
|
-
|
|
19
|
-
def self.readme_path
|
|
20
|
-
return config.readme_path if config.readme_path
|
|
21
|
-
%w[README.md README.markdown README.mdown README].each do |potential_name|
|
|
22
|
-
file = config.source_directory + potential_name
|
|
23
|
-
return file if file.exist?
|
|
24
|
-
end
|
|
25
|
-
nil
|
|
26
|
-
end
|
|
27
|
-
|
|
28
|
-
def self.generated_readme(source_module)
|
|
29
|
-
if podspec = config.podspec
|
|
30
|
-
### License
|
|
31
|
-
|
|
32
|
-
# <a href="#{license[:url]}">#{license[:license]}</a>
|
|
33
|
-
<<-EOS
|
|
34
|
-
# #{podspec.name}
|
|
35
|
-
|
|
36
|
-
### #{podspec.summary}
|
|
37
|
-
|
|
38
|
-
#{podspec.description}
|
|
39
|
-
|
|
40
|
-
### Installation
|
|
41
|
-
|
|
42
|
-
```ruby
|
|
43
|
-
pod '#{podspec.name}'
|
|
44
|
-
```
|
|
45
|
-
|
|
46
|
-
### Authors
|
|
47
|
-
|
|
48
|
-
#{source_module.author_name}
|
|
49
|
-
EOS
|
|
50
|
-
else
|
|
51
|
-
<<-EOS
|
|
52
|
-
# #{source_module.name}
|
|
53
|
-
|
|
54
|
-
### Authors
|
|
55
|
-
|
|
56
|
-
#{source_module.author_name}
|
|
57
|
-
EOS
|
|
58
|
-
end
|
|
59
|
-
end
|
|
60
|
-
end
|
|
61
|
-
end
|