jazzy 0.0.13 → 0.0.14

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.
Files changed (42) hide show
  1. checksums.yaml +4 -4
  2. data/.rubocop.yml +4 -3
  3. data/Gemfile.lock +5 -3
  4. data/Rakefile +4 -2
  5. data/bin/sourcekitten +0 -0
  6. data/jazzy.gemspec +1 -0
  7. data/lib/jazzy/assets/css/{jazzy.css → jazzy.css.scss} +199 -231
  8. data/lib/jazzy/config.rb +27 -13
  9. data/lib/jazzy/doc.mustache +2 -2
  10. data/lib/jazzy/doc.rb +2 -1
  11. data/lib/jazzy/doc_builder.rb +124 -70
  12. data/lib/jazzy/gem_version.rb +1 -1
  13. data/lib/jazzy/source_module.rb +28 -0
  14. data/lib/jazzy/sourcekitten.rb +95 -70
  15. data/lib/jazzy/xml_helper.rb +2 -1
  16. data/spec/integration_specs/document_alamofire/after/docs/Classes.html +2 -2
  17. data/spec/integration_specs/document_alamofire/after/docs/Classes/Manager.html +2 -2
  18. data/spec/integration_specs/document_alamofire/after/docs/Classes/Manager/init(configuration:).html +2 -2
  19. data/spec/integration_specs/document_alamofire/after/docs/Classes/Request.html +2 -2
  20. data/spec/integration_specs/document_alamofire/after/docs/Enums.html +2 -2
  21. data/spec/integration_specs/document_alamofire/after/docs/Enums/ParameterEncoding.html +2 -2
  22. data/spec/integration_specs/document_alamofire/after/docs/Extensions.html +2 -2
  23. data/spec/integration_specs/document_alamofire/after/docs/Extensions/Manager.html +2 -2
  24. data/spec/integration_specs/document_alamofire/after/docs/Extensions/Request.html +2 -2
  25. data/spec/integration_specs/document_alamofire/after/docs/Functions.html +2 -2
  26. data/spec/integration_specs/document_alamofire/after/docs/Global Variables.html +2 -2
  27. data/spec/integration_specs/document_alamofire/after/docs/Protocols.html +2 -2
  28. data/spec/integration_specs/document_alamofire/after/docs/Protocols/URLRequestConvertible.html +2 -2
  29. data/spec/integration_specs/document_alamofire/after/docs/Protocols/URLStringConvertible.html +2 -2
  30. data/spec/integration_specs/document_alamofire/after/docs/css/jazzy.css +140 -257
  31. data/spec/integration_specs/document_alamofire/after/docs/index.html +2 -2
  32. data/spec/integration_specs/document_alamofire/after/execution_output.txt +2 -1
  33. data/spec/integration_specs/misc_jazzy_features/after/docs/Classes.html +2 -2
  34. data/spec/integration_specs/misc_jazzy_features/after/docs/Classes/ImplicitlyInternalTopLevelClass.html +2 -2
  35. data/spec/integration_specs/misc_jazzy_features/after/docs/Enums.html +2 -2
  36. data/spec/integration_specs/misc_jazzy_features/after/docs/Enums/DocumentedEnum.html +2 -2
  37. data/spec/integration_specs/misc_jazzy_features/after/docs/Global Variables.html +2 -2
  38. data/spec/integration_specs/misc_jazzy_features/after/docs/css/jazzy.css +140 -257
  39. data/spec/integration_specs/misc_jazzy_features/after/docs/index.html +2 -2
  40. data/spec/integration_specs/misc_jazzy_features/after/execution_output.txt +2 -1
  41. metadata +18 -4
  42. data/.rubocop_todo.yml +0 -24
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: a743a1183b2ea0e4e08000c6bec4e7dc31550320
4
- data.tar.gz: 963b1c2d42300f2e7014569e7e11eaf9b6211745
3
+ metadata.gz: 6e5a10f6a6e2ae160d56aacfb558c9494dbcb63c
4
+ data.tar.gz: b1476b977cc1e71e2b508263b5c750f368ed34fb
5
5
  SHA512:
6
- metadata.gz: c0f647e4bb2bcee1ce46463f3d73a1df6b09f62ef752a9fa10ef36b665e2a53a68fee1e7b41acd5bc07bd147c0274882213b97d6bdff1ee9bbd1acc1e3ba105d
7
- data.tar.gz: 8eacf77a65ffa52f47e40ca0a9e5970cfae1ff78431ceedf97393c70f643e4bdb2deb9a67dbc3a61e899902bbd0473983fde823c4a9b523cb88d6a91d363d367
6
+ metadata.gz: ae051cb030b903b460907f8cc5dd041f7c6bae179ff3cc8f7ec14271d0c44cfb80b7e99734c866f2d138d6cb0907fe59c8ee6e12251245b960ead1a5089b9f73
7
+ data.tar.gz: 370f5f57284c90032514209c47c2191b85ccd890d86ace267669bea4a559c23921985a6a20cd0b259dcc484e0d22d82075720037dd5c9b2e01bfac99d6bb7413
data/.rubocop.yml CHANGED
@@ -1,6 +1,3 @@
1
- inherit_from:
2
- - .rubocop_todo.yml
3
-
4
1
  AllCops:
5
2
  Include:
6
3
  - ./Rakefile
@@ -14,6 +11,10 @@ Documentation:
14
11
 
15
12
  #- Jazzy -----------------------------------------------------------------#
16
13
 
14
+ # 20 lines is more reasonable than rubocop's default of 10
15
+ Metrics/MethodLength:
16
+ Max: 20
17
+
17
18
  # We adopted raise instead of fail.
18
19
  SignalException:
19
20
  EnforcedStyle: only_raise
data/Gemfile.lock CHANGED
@@ -1,11 +1,12 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- jazzy (0.0.13)
4
+ jazzy (0.0.14)
5
5
  activesupport (~> 4.1)
6
6
  mustache (~> 0.99)
7
7
  nokogiri (~> 1.6)
8
8
  redcarpet (~> 3.2)
9
+ sass (~> 3.4)
9
10
 
10
11
  GEM
11
12
  remote: http://rubygems.org/
@@ -28,7 +29,7 @@ GEM
28
29
  crack (0.4.2)
29
30
  safe_yaml (~> 1.0.0)
30
31
  diffy (3.0.7)
31
- i18n (0.6.9)
32
+ i18n (0.6.11)
32
33
  json (1.8.1)
33
34
  metaclass (0.0.4)
34
35
  mini_portile (0.6.1)
@@ -38,7 +39,7 @@ GEM
38
39
  mocha-on-bacon (0.2.2)
39
40
  mocha (>= 0.13.0)
40
41
  mustache (0.99.7)
41
- nokogiri (1.6.4)
42
+ nokogiri (1.6.4.1)
42
43
  mini_portile (~> 0.6.0)
43
44
  parser (2.2.0.pre.5)
44
45
  ast (>= 1.1, < 3.0)
@@ -57,6 +58,7 @@ GEM
57
58
  ruby-progressbar (~> 1.4)
58
59
  ruby-progressbar (1.6.0)
59
60
  safe_yaml (1.0.4)
61
+ sass (3.4.7)
60
62
  slop (3.6.0)
61
63
  thread_safe (0.3.4)
62
64
  tzinfo (1.2.2)
data/Rakefile CHANGED
@@ -48,8 +48,10 @@ begin
48
48
 
49
49
  # Remove files not used for the comparison
50
50
  # To keep the git diff clean
51
- files_to_delete = FileList['spec/integration_specs/*/after/{*,.git,.gitignore}']
52
- .exclude('spec/integration_specs/*/after/docs', 'spec/integration_specs/*/after/execution_output.txt')
51
+ files_glob = 'spec/integration_specs/*/after/{*,.git,.gitignore}'
52
+ files_to_delete = FileList[files_glob]
53
+ .exclude('spec/integration_specs/*/after/docs',
54
+ 'spec/integration_specs/*/after/execution_output.txt')
53
55
  files_to_delete.each do |file_to_delete|
54
56
  sh "rm -rf '#{file_to_delete}'"
55
57
  end
data/bin/sourcekitten CHANGED
Binary file
data/jazzy.gemspec CHANGED
@@ -21,6 +21,7 @@ Gem::Specification.new do |spec|
21
21
  spec.add_runtime_dependency 'activesupport', '~> 4.1'
22
22
  spec.add_runtime_dependency 'redcarpet', '~> 3.2'
23
23
  spec.add_runtime_dependency 'nokogiri', '~> 1.6'
24
+ spec.add_runtime_dependency 'sass', '~> 3.4'
24
25
 
25
26
  spec.add_development_dependency 'bundler', '~> 1.7'
26
27
  spec.add_development_dependency 'rake', '~> 10.3'
@@ -1,3 +1,5 @@
1
+ $doc_coverage_color: #999;
2
+
1
3
  html, body, div, span, h1, h3, h4, p, a, code, em, img, ul, li, table, tbody, tr, td {
2
4
  background: transparent;
3
5
  border: 0;
@@ -8,48 +10,43 @@ html, body, div, span, h1, h3, h4, p, a, code, em, img, ul, li, table, tbody, tr
8
10
  vertical-align: baseline;
9
11
  }
10
12
 
11
- #reference .x-instance-method.Swift {
12
- margin-left: 15px;
13
- }
14
-
15
- #reference .chapter {
16
- overflow-x: hidden;
17
- border-top: 0;
18
- border-left: 1px solid rgba(233, 233, 233, 1);
19
- border-right: 1px solid rgba(233, 233, 233, 1);
20
- border-bottom: 1px solid rgba(233, 233, 233, 1);
21
- }
22
-
23
- #reference .nav-chapters {
24
- height: 100%;
25
- }
26
-
27
- #reference .part-name {
28
- color: #000;
29
- cursor: default;
30
- padding: 15px 15px 15px 20px;
31
- min-height: 61px;
32
- }
33
-
34
- #reference .part-name.tasks {
35
- background: #fff;
36
- overflow: auto;
37
- }
38
-
39
- #reference .book-parts a {
40
- display: initial;
41
- margin-left: 0;
42
- }
43
-
44
- #reference .nav-chapters li {
45
- color: rgba(128, 128, 128, 1);
46
- margin-left: 12px;
47
- padding-left: 10px;
48
- text-indent: -10px;
49
- }
50
-
51
- #reference .chapter-name {
52
- margin-top: 21px;
13
+ #reference {
14
+ .x-instance-method.Swift {
15
+ margin-left: 15px;
16
+ }
17
+ .chapter {
18
+ overflow-x: hidden;
19
+ border-top: 0;
20
+ border-left: 1px solid rgba(233, 233, 233, 1);
21
+ border-right: 1px solid rgba(233, 233, 233, 1);
22
+ border-bottom: 1px solid rgba(233, 233, 233, 1);
23
+ }
24
+ .nav-chapters {
25
+ height: 100%;
26
+ }
27
+ .part-name {
28
+ color: #000;
29
+ cursor: default;
30
+ padding: 15px 15px 15px 20px;
31
+ min-height: 61px;
32
+ &.tasks {
33
+ background: #fff;
34
+ overflow: auto;
35
+ }
36
+ }
37
+ .book-parts a {
38
+ display: initial;
39
+ margin-left: 0;
40
+ }
41
+ .nav-chapters li {
42
+ color: rgba(128, 128, 128, 1);
43
+ margin-left: 12px;
44
+ padding-left: 10px;
45
+ text-indent: -10px;
46
+ }
47
+ .chapter-name {
48
+ margin-top: 21px;
49
+ }
53
50
  }
54
51
 
55
52
  .rubber-band-gap {
@@ -62,168 +59,145 @@ html, body, div, span, h1, h3, h4, p, a, code, em, img, ul, li, table, tbody, tr
62
59
  margin: 0 0 0 247px;
63
60
  }
64
61
 
65
- #reference .task-name-container {
66
- background: #fff;
67
- left: -25px;
68
- margin-bottom: 0;
69
- padding: 35px 25px 0;
70
- position: relative;
71
- width: 100%;
72
- }
73
-
74
- #reference .section-name {
75
- cursor: pointer;
76
- display: inline-block;
77
- }
78
-
79
- #reference .section .section {
80
- margin-top: 0;
81
- }
82
-
83
- #reference .task-group-section {
84
- padding: 1px 25px 0;
85
- }
86
-
87
- #reference .symbol {
88
- background: #fff;
89
- left: -25px;
90
- list-style-type: none;
91
- padding: 13px 25px 0;
92
- position: relative;
93
- width: 100%;
94
- }
95
-
96
- #reference .task-group-term {
97
- font-size: 1.4em;
98
- word-break: break-all;
99
- }
100
-
101
- #reference .task-group-term>code {
102
- display: inline-block;
103
- }
104
-
105
- #reference .pointy-thing-container {
106
- background: #fff;
107
- border-bottom: 1px solid rgba(233, 233, 233, 1);
108
- left: -25px;
109
- padding-left: 25px;
110
- padding-right: 25px;
111
- padding-bottom: 13px;
112
- position: relative;
113
- width: 100%;
114
- }
115
-
116
- #reference .pointy-thing {
117
- background: rgba(249, 249, 249, 1);
118
- border-left: 1px solid rgba(233, 233, 233, 1);
119
- border-top: 1px solid rgba(233, 233, 233, 1);
120
- height: 12px;
121
- left: 21px;
122
- top: -7px;
123
- -webkit-transform: rotate(45deg);
124
- -moz-transform: rotate(45deg);
125
- -o-transform: rotate(45deg);
126
- transform: rotate(45deg);
127
- position: absolute;
128
- width: 12px;
129
- }
130
-
131
- #reference .height-container {
132
- display: none;
133
- left: -25px;
134
- padding: 0 25px;
135
- position: relative;
136
- width: 100%;
137
- overflow: hidden;
138
- }
139
-
140
- #reference .height-container .section {
141
- background: rgba(249, 249, 249, 1);
142
- border-bottom: 1px solid rgba(233, 233, 233, 1);
143
- left: -25px;
144
- margin: 0;
145
- padding: 13px 25px 0;
146
- position: relative;
147
- width: 100%;
148
- }
149
-
150
- #reference .height-container .section h4 {
151
- font-size: 13px;
152
- line-height: 1.5;
153
- margin-top: 21px;
154
- }
155
-
156
- #reference .section .declaration {
157
- margin-top: 21px;
158
- }
159
-
160
- #reference .section .declaration code {
161
- color: rgba(128, 128, 128, 1);
162
- margin-bottom: 15px;
163
- padding-bottom: 6px;
164
- }
165
-
166
- #reference .declaration div .para {
167
- margin-bottom: 0;
168
- }
169
-
170
- #reference .task-group .item .graybox {
171
- margin: 5px 0 26px;
172
- }
173
-
174
- #reference .symbol .graybox .para:last-of-type {
175
- margin-bottom: 0;
176
- padding-bottom: 0;
177
- }
178
-
179
- #reference .parameters .graybox tr td:first-of-type {
180
- text-align: right;
181
- padding: 7px;
182
- vertical-align: top;
183
- word-break: normal;
184
- width: 40px;
185
- }
186
-
187
- #reference em.term,
188
- #reference em.parameter-name {
189
- color: rgba(65, 65, 65, 1);
190
- font-size: 12px;
191
- line-height: 1.5;
192
- }
193
-
194
- #reference .height-container .section>div:last-of-type {
195
- margin-bottom: 15px;
196
- }
197
-
198
- #reference #footer {
199
- width: 614px;
200
- z-index: 1;
201
- }
202
-
203
- #reference .item .para {
204
- padding-bottom: 0;
205
- margin: 0 0 15px;
206
- }
207
-
208
- #reference a[name] {
209
- padding-top: 112px;
210
- margin: -112px 0 0;
211
- }
212
-
213
- #reference .height-container td {
214
- max-width: inherit;
215
- }
216
-
217
- #reference .declaration .n a {
218
- color: inherit;
219
- }
220
-
221
- #reference .declaration .n a:hover {
222
- border-bottom: 1px solid;
223
- }
224
-
225
- #reference .copyright {
226
- margin: 10px 0;
62
+ #reference {
63
+ .task-name-container {
64
+ background: #fff;
65
+ left: -25px;
66
+ margin-bottom: 0;
67
+ padding: 35px 25px 0;
68
+ position: relative;
69
+ width: 100%;
70
+ }
71
+ .section-name {
72
+ cursor: pointer;
73
+ display: inline-block;
74
+ }
75
+ .section .section {
76
+ margin-top: 0;
77
+ }
78
+ .task-group-section {
79
+ padding: 1px 25px 0;
80
+ }
81
+ .symbol {
82
+ background: #fff;
83
+ left: -25px;
84
+ list-style-type: none;
85
+ padding: 13px 25px 0;
86
+ position: relative;
87
+ width: 100%;
88
+ }
89
+ .task-group-term {
90
+ font-size: 1.4em;
91
+ word-break: break-all;
92
+ > code {
93
+ display: inline-block;
94
+ }
95
+ }
96
+ .pointy-thing-container {
97
+ background: #fff;
98
+ border-bottom: 1px solid rgba(233, 233, 233, 1);
99
+ left: -25px;
100
+ padding-left: 25px;
101
+ padding-right: 25px;
102
+ padding-bottom: 13px;
103
+ position: relative;
104
+ width: 100%;
105
+ }
106
+ .pointy-thing {
107
+ background: rgba(249, 249, 249, 1);
108
+ border-left: 1px solid rgba(233, 233, 233, 1);
109
+ border-top: 1px solid rgba(233, 233, 233, 1);
110
+ height: 12px;
111
+ left: 21px;
112
+ top: -7px;
113
+ -webkit-transform: rotate(45deg);
114
+ -moz-transform: rotate(45deg);
115
+ -o-transform: rotate(45deg);
116
+ transform: rotate(45deg);
117
+ position: absolute;
118
+ width: 12px;
119
+ }
120
+ .height-container {
121
+ display: none;
122
+ left: -25px;
123
+ padding: 0 25px;
124
+ position: relative;
125
+ width: 100%;
126
+ overflow: hidden;
127
+ .section {
128
+ background: rgba(249, 249, 249, 1);
129
+ border-bottom: 1px solid rgba(233, 233, 233, 1);
130
+ left: -25px;
131
+ margin: 0;
132
+ padding: 13px 25px 0;
133
+ position: relative;
134
+ width: 100%;
135
+ h4 {
136
+ font-size: 13px;
137
+ line-height: 1.5;
138
+ margin-top: 21px;
139
+ }
140
+ }
141
+ }
142
+ .section .declaration {
143
+ margin-top: 21px;
144
+ code {
145
+ color: rgba(128, 128, 128, 1);
146
+ margin-bottom: 15px;
147
+ padding-bottom: 6px;
148
+ }
149
+ }
150
+ .declaration div .para {
151
+ margin-bottom: 0;
152
+ }
153
+ .task-group .item .graybox {
154
+ margin: 5px 0 26px;
155
+ }
156
+ .symbol .graybox .para:last-of-type {
157
+ margin-bottom: 0;
158
+ padding-bottom: 0;
159
+ }
160
+ .parameters .graybox tr td:first-of-type {
161
+ text-align: right;
162
+ padding: 7px;
163
+ vertical-align: top;
164
+ word-break: normal;
165
+ width: 40px;
166
+ }
167
+ em {
168
+ &.term, &.parameter-name {
169
+ color: rgba(65, 65, 65, 1);
170
+ font-size: 12px;
171
+ line-height: 1.5;
172
+ }
173
+ }
174
+ .height-container .section > div:last-of-type {
175
+ margin-bottom: 15px;
176
+ }
177
+ #footer {
178
+ width: 614px;
179
+ z-index: 1;
180
+ }
181
+ .item .para {
182
+ padding-bottom: 0;
183
+ margin: 0 0 15px;
184
+ }
185
+ a[name] {
186
+ padding-top: 112px;
187
+ margin: -112px 0 0;
188
+ }
189
+ .height-container td {
190
+ max-width: inherit;
191
+ }
192
+ .declaration .n a {
193
+ color: inherit;
194
+ &:hover {
195
+ border-bottom: 1px solid;
196
+ }
197
+ }
198
+ .copyright {
199
+ margin: 10px 0;
200
+ }
227
201
  }
228
202
 
229
203
  .nav-chapters {
@@ -277,7 +251,7 @@ a[name] {
277
251
  background-color: #fff;
278
252
  border: 1px solid rgba(233, 233, 233, 1);
279
253
  border-top: 0;
280
- box-shadow: 0 0 1px rgba(0, 0, 0, .07);
254
+ box-shadow: 0 0 1px rgba(0, 0, 0, 0.07);
281
255
  display: block;
282
256
  margin-left: 246px;
283
257
  min-height: calc(100% - 173px);
@@ -301,16 +275,15 @@ a[name] {
301
275
 
302
276
  .section {
303
277
  padding: 15px 25px 0px;
304
- }
305
-
306
- .section .section {
307
- margin: 30px 0 0;
308
- padding: 0;
278
+ .section {
279
+ margin: 30px 0 0;
280
+ padding: 0;
281
+ }
309
282
  }
310
283
 
311
284
  header {
312
285
  background-color: rgba(65, 65, 65, 1);
313
- box-shadow: 0 1px 1px rgba(0, 0, 0, .07);
286
+ box-shadow: 0 1px 1px rgba(0, 0, 0, 0.07);
314
287
  color: #fff;
315
288
  height: 25px;
316
289
  letter-spacing: .05em;
@@ -326,11 +299,11 @@ header {
326
299
  padding-top: 6px;
327
300
  vertical-align: middle;
328
301
  float: left;
329
- }
330
-
331
- .header-text a {
332
- color: #fff;
333
- text-decoration: none;
302
+ color: $doc_coverage_color;
303
+ a {
304
+ color: #fff;
305
+ text-decoration: none;
306
+ }
334
307
  }
335
308
 
336
309
  #header-icon {
@@ -433,7 +406,7 @@ h3.section-name:before {
433
406
  border-left: 1px solid rgba(233, 233, 233, 1);
434
407
  border-right: 1px solid rgba(233, 233, 233, 1);
435
408
  bottom: 0;
436
- box-shadow: 0 0 1px rgba(0, 0, 0, .07);
409
+ box-shadow: 0 0 1px rgba(0, 0, 0, 0.07);
437
410
  overflow: auto;
438
411
  -webkit-overflow-scrolling: touch;
439
412
  position: fixed;
@@ -508,15 +481,11 @@ h3.section-name:before {
508
481
  div.Swift {
509
482
  padding: 4px 0 2px 10px;
510
483
  margin: 10px 0 21px;
511
- }
512
-
513
- div.Swift {
514
484
  border-left: 5px solid rgba(205, 233, 244, 1);
515
- }
516
-
517
- div.Swift .aside-title {
518
- color: rgba(75, 138, 251, 1);
519
- -webkit-user-select: none;
485
+ .aside-title {
486
+ color: rgba(75, 138, 251, 1);
487
+ -webkit-user-select: none;
488
+ }
520
489
  }
521
490
 
522
491
  #footer {
@@ -536,12 +505,11 @@ div.Swift .aside-title {
536
505
  margin: 20px 0 36px;
537
506
  text-align: left;
538
507
  width: 100%;
539
- }
540
-
541
- .graybox p {
542
- margin: 0;
543
- word-break: break-word;
544
- min-width: 50px;
508
+ p {
509
+ margin: 0;
510
+ word-break: break-word;
511
+ min-width: 50px;
512
+ }
545
513
  }
546
514
 
547
515
  td {