jazzy 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1ba4df57d1e45977d30b8750eb7eff74759ce13a
-  data.tar.gz: b6f6d7e0011d40af6689dae141e342d227dd4ca5
+  metadata.gz: 0ba1de18fa3f65a96e4194a16af54548702703a3
+  data.tar.gz: b672b6be8ae8d3dd5e7fb01b3b38e8193f64e2f3
 SHA512:
-  metadata.gz: 8b1749a9f82aafbd45fe25a944391d0b8b8cd6142afbfc1b166599c7f06cbc5e63690c390ea9bfefdece70ccc29ad014157bdbf8fbbf779e163c68403e92fcf5
-  data.tar.gz: dcf0827899624fdef0e30221c4d74a34cc081a03e359ff107d65949c8ea27e7803abef645efad4eaee96a7f8fd5118ff2b550b0a4dc9548fff1dd597c862b840
+  metadata.gz: 750b810f71f2b796acfab8b17a0f4b74fc27efd22098086a77d469a035b5a977921bea452e93603c05ede5a14e9e2fcef39286f491e504ac2036b47a0ab24a5f
+  data.tar.gz: 82dd5f2f81eaac159ce85f4444e72407a09dbb5dbfcc151a4e9c4ff2866ac8e06a6aa5893a61548d4c3ca8168a6176303ee77c8c62f4851a5e9bdab228c55498

data/.rubocop.yml

@@ -51,12 +51,19 @@ Encoding:
 
 # Having these make it easier to *not* forget to add one when adding a new
 # value and you can simply copy the previous line.
-TrailingComma:
+TrailingCommaInLiteral:
+  EnforcedStyleForMultiline: comma
+
+TrailingCommaInArguments:
   EnforcedStyleForMultiline: comma
 
 Style/SpecialGlobalVars:
   Enabled: false
 
+# We prefer explicit `a, _ = arr` to `a, = arr` (which could be misread as a stray comma)
+Style/TrailingUnderscoreVariable:
+  Enabled: false
+
 # For lambdas nested within certain expressions, this rule forces either ugly
 # parens or curly braces that violate the "do/end for multiline blocks" rule.
 Lambda:
@@ -74,6 +81,9 @@ GuardClause:
 Next:
   Enabled: false
 
+RegexpLiteral:
+  EnforcedStyle: mixed
+
 #- Jazzy specs -----------------------------------------------------------#
 
 # Allow for `should.match /regexp/`.

data/.travis.yml

@@ -11,5 +11,5 @@ notifications:
   slack: realmio:vPdpsG9NLDo2DNlbqtcMAQuE
 matrix:
   include:
-    - osx_image: xcode7.2
-      env: TRAVIS_SWIFT_VERSION=2.1.1
+    - osx_image: xcode7.3
+      env: TRAVIS_SWIFT_VERSION=2.2

data/CHANGELOG.md

@@ -1,3 +1,45 @@
+## 0.6.0
+
+##### Breaking
+
+* Config files now use the same option names as the command line. If you are
+  using one of the keys that has changed in your `.jazzy.yaml`, you will receive
+  a warning. See the [pull request](https://github.com/realm/jazzy/pull/456) for
+  a complete list of changed options. As always, you can get a list of all
+  options with `jazzy --help config`.  
+  [Paul Cantrell](https://github.com/pcantrell)
+* Jazzy's undocumented.txt has been replaced with undocumented.json. This new
+  format includes contextual information that one might use to lint
+  documentation in an automated fashion.  
+  [Jeff Verkoeyen](https://github.com/jverkoey)
+* `--swift-version` now defaults to 2.2 instead of 2.1.1.  
+  [Tamar Nachmany](https://github.com/tamarnachmany)
+
+##### Enhancements
+
+* Add `--skip-documentation` flag. Skips site generation phase. `undocumented.json`
+  is still generated.  
+  [Jeff Verkoeyen](https://github.com/jverkoey)
+* Merge Objective-C categories into their parent type documentation to match
+  Swift behavior.  
+  [Esad Hajdarevic](https://github.com/esad)
+  [#457](https://github.com/realm/jazzy/issues/457)
+* Add support for documenting Swift 2.2 `associatedtype`s and infix, postfix &
+  prefix operators.  
+  [JP Simard](https://github.com/jpsim)
+
+##### Bug Fixes
+
+* Add support for Objective-C module imports.  
+  [JP Simard](https://github.com/jpsim)
+  [#452](https://github.com/realm/jazzy/issues/452)
+
+* Workaround for an apparent SourceKit bug which sometimes caused extensions
+  to be merged into the wrong type.  
+  [Paul Cantrell](https://github.com/pcantrell)
+  [#459](https://github.com/realm/jazzy/issues/459)
+  [#460](https://github.com/realm/jazzy/issues/460)
+
 ## 0.5.0
 
 ##### Breaking
@@ -66,7 +108,7 @@
   - New `...` wildcard prevents you from having to list all method parameters:
     `someMethod(...)`
 
-  [pcantrell](https://github.com/pcantrell)
+  [Paul Cantrell](https://github.com/pcantrell)
   [#327](https://github.com/realm/jazzy/issues/327)
   [#329](https://github.com/realm/jazzy/issues/329)
   [#359](https://github.com/realm/jazzy/issues/359)
@@ -90,12 +132,12 @@
 
 * Links to source files on GitHub are no longer broken when `source_directory`
   does not point to the current working directory.  
-  [pcantrell](https://github.com/pcantrell)
+  [Paul Cantrell](https://github.com/pcantrell)
 
 * When `excluded_files` is specified in a config file, it is now resolved
   relative to the file (like other options) instead of relative to the working
   directory.  
-  [pcantrell](https://github.com/pcantrell)
+  [Paul Cantrell](https://github.com/pcantrell)
 
 
 ## 0.4.0
@@ -118,7 +160,7 @@
 
 * Jazzy can now read options from a configuration file. The command line
   provides comprehensive help for available options via `jazzy -h config`.  
-  [pcantrell](https://github.com/pcantrell)
+  [Paul Cantrell](https://github.com/pcantrell)
   [#310](https://github.com/realm/jazzy/pull/310)
 
 * Render special list items (e.g. Throws, See, etc.). See
@@ -132,7 +174,7 @@
 
 * Swift extensions are now merged with their extended type, rendering a note
   to describe extension default implementations and extension methods.  
-  [pcantrell](https://github.com/pcantrell)
+  [Paul Cantrell](https://github.com/pcantrell)
 
 ##### Bug Fixes
 
@@ -196,7 +238,7 @@
 
 * Declarations can now be grouped by custom categories defined in a JSON or YAML
   file passed to `--categories`.  
-  [pcantrell](https://github.com/pcantrell)
+  [Paul Cantrell](https://github.com/pcantrell)
 
 ##### Bug Fixes
 
@@ -205,7 +247,7 @@
   [#244](https://github.com/realm/jazzy/issues/244)
 
 * Empty extensions are no longer documented.  
-  [pcantrell](https://github.com/pcantrell)
+  [Paul Cantrell](https://github.com/pcantrell)
 
 * Undocumented enum cases are now supported.  
   [JP Simard](https://github.com/jpsim)
@@ -224,7 +266,7 @@
   [JP Simard](https://github.com/jpsim)
 
 * Show type declaration under its title.  
-  [pcantrell](https://github.com/pcantrell)
+  [Paul Cantrell](https://github.com/pcantrell)
 
 * Added support for custom assets: pass `--assets-directory` to jazzy.  
   [gurkendoktor](https://github.com/gurkendoktor)
@@ -239,7 +281,7 @@
   [#236](https://github.com/realm/jazzy/issues/236)
 
 * `--exclude` now works properly if its argument is a relative path.  
-  [pcantrell](https://github.com/pcantrell)
+  [Paul Cantrell](https://github.com/pcantrell)
 
 
 ## 0.2.3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    jazzy (0.4.1)
+    jazzy (0.6.0)
       cocoapods (~> 0.39)
       mustache (~> 0.99)
       open4
@@ -9,12 +9,12 @@ PATH
       rouge (~> 1.5)
       sass (~> 3.4)
       sqlite3 (~> 1.3)
-      xcinvoke (~> 0.2.0)
+      xcinvoke (~> 0.2.1)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    activesupport (4.2.5)
+    activesupport (4.2.6)
       i18n (~> 0.7)
       json (~> 1.7, >= 1.7.7)
       minitest (~> 5.1)
@@ -22,8 +22,6 @@ GEM
       tzinfo (~> 1.1)
     addressable (2.4.0)
     ast (2.2.0)
-    astrolabe (1.3.1)
-      parser (~> 2.2)
     bacon (1.2.0)
     claide (0.9.1)
     clintegracon (0.7.0)
@@ -63,50 +61,49 @@ GEM
     diffy (3.1.0)
     escape (0.0.4)
     fuzzy_match (2.0.4)
-    hashdiff (0.2.3)
+    hashdiff (0.3.0)
     i18n (0.7.0)
     json (1.8.3)
     liferaft (0.0.4)
     metaclass (0.0.4)
-    minitest (5.8.3)
+    minitest (5.8.4)
     mocha (1.1.0)
       metaclass (~> 0.0.1)
     mocha-on-bacon (0.2.2)
       mocha (>= 0.13.0)
-    molinillo (0.4.0)
+    molinillo (0.4.4)
     mustache (0.99.8)
-    nap (1.0.0)
+    nap (1.1.0)
     netrc (0.7.8)
     open4 (1.3.4)
-    parser (2.2.3.0)
-      ast (>= 1.1, < 3.0)
+    parser (2.3.0.7)
+      ast (~> 2.2)
     powerpack (0.1.1)
     prettybacon (0.0.2)
       bacon (~> 1.2)
-    rainbow (2.0.0)
-    rake (10.4.2)
+    rainbow (2.1.0)
+    rake (10.5.0)
     redcarpet (3.3.4)
     rouge (1.10.1)
-    rubocop (0.35.1)
-      astrolabe (~> 1.3)
-      parser (>= 2.2.3.0, < 3.0)
+    rubocop (0.39.0)
+      parser (>= 2.3.0.7, < 3.0)
       powerpack (~> 0.1)
       rainbow (>= 1.99.1, < 3.0)
       ruby-progressbar (~> 1.7)
-      tins (<= 1.6.0)
+      unicode-display_width (~> 1.0, >= 1.0.1)
     ruby-progressbar (1.7.5)
     safe_yaml (1.0.4)
-    sass (3.4.20)
+    sass (3.4.22)
     sqlite3 (1.3.11)
     thread_safe (0.3.5)
-    tins (1.6.0)
     tzinfo (1.2.2)
       thread_safe (~> 0.1)
-    webmock (1.22.3)
+    unicode-display_width (1.0.3)
+    webmock (1.24.2)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff
-    xcinvoke (0.2.0)
+    xcinvoke (0.2.1)
       liferaft (~> 0.0.4)
     xcodeproj (0.28.2)
       activesupport (>= 3)
@@ -130,4 +127,4 @@ DEPENDENCIES
   webmock
 
 BUNDLED WITH
-   1.10.6
+   1.11.2

data/README.md

@@ -66,7 +66,7 @@ jazzy \
   --module RealmSwift \
   --root-url https://realm.io/docs/swift/0.96.2/api/ \
   --output docs/swift_output \
-  --template-directory docs/templates
+  --theme docs/themes
 ```
 
 ### Objective-C
@@ -98,7 +98,7 @@ jazzy \
   --module Realm \
   --root-url https://realm.io/docs/objc/0.96.2/api/ \
   --output docs/objc_output \
-  --template-directory docs/templates
+  --theme docs/themes
 ```
 
 This is how the AFNetworking docs are generated:
@@ -122,7 +122,7 @@ Two themes are provided with jazzy: `apple` (default) and `fullwidth`.
 
 Here's an example built with `apple`: <https://realm.io/docs/swift/latest/api/>
 
-Here's an example built with `fullwidth`: <http://reduxkit.github.io/ReduxKit/api/>
+Here's an example built with `fullwidth`: <http://reduxkit.github.io/ReduxKit/>
 
 You can specify which theme to use by passing in the `--theme` option. You can
 also provide your own custom theme by passing in the path to your theme

data/Rakefile

@@ -54,9 +54,10 @@ begin
 
     # Remove files not used for the comparison
     # To keep the git diff clean
-    files_glob = 'spec/integration_specs/*/after/{*,.git,.gitignore}'
+    files_glob = 'spec/integration_specs/*/after/{*,.*}'
     files_to_delete = FileList[files_glob]
-      .exclude('spec/integration_specs/*/after/docs',
+      .exclude('**/.', '**/..')
+      .exclude('spec/integration_specs/*/after/*docs',
                'spec/integration_specs/*/after/execution_output.txt')
       .include('**/*.dsidx')
       .include('**/*.tgz')

data/jazzy.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'rouge', '~> 1.5'
   spec.add_runtime_dependency 'sass', '~> 3.4'
   spec.add_runtime_dependency 'sqlite3', '~> 1.3'
-  spec.add_runtime_dependency 'xcinvoke', '~> 0.2.0'
+  spec.add_runtime_dependency 'xcinvoke', '~> 0.2.1'
 
   spec.add_development_dependency 'bundler', '~> 1.7'
   spec.add_development_dependency 'rake', '~> 10.3'

data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Commandant.framework/Versions/A/Resources/Info.plist

@@ -3,7 +3,7 @@
 <plist version="1.0">
 <dict>
 	<key>BuildMachineOSBuild</key>
-	<string>15C50</string>
+	<string>15E65</string>
 	<key>CFBundleDevelopmentRegion</key>
 	<string>en</string>
 	<key>CFBundleExecutable</key>
@@ -17,7 +17,7 @@
 	<key>CFBundlePackageType</key>
 	<string>FMWK</string>
 	<key>CFBundleShortVersionString</key>
-	<string>0.7.0</string>
+	<string>0.8.2</string>
 	<key>CFBundleSignature</key>
 	<string>????</string>
 	<key>CFBundleSupportedPlatforms</key>
@@ -29,17 +29,17 @@
 	<key>DTCompiler</key>
 	<string>com.apple.compilers.llvm.clang.1_0</string>
 	<key>DTPlatformBuild</key>
-	<string>7C68</string>
+	<string>7D175</string>
 	<key>DTPlatformVersion</key>
 	<string>GM</string>
 	<key>DTSDKBuild</key>
-	<string>15C43</string>
+	<string>15E60</string>
 	<key>DTSDKName</key>
 	<string>macosx10.11</string>
 	<key>DTXcode</key>
-	<string>0720</string>
+	<string>0730</string>
 	<key>DTXcodeBuild</key>
-	<string>7C68</string>
+	<string>7D175</string>
 	<key>NSHumanReadableCopyright</key>
 	<string>Copyright © 2014 Carthage. All rights reserved.</string>
 </dict>

data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Result.framework/Versions/A/Resources/Info.plist

@@ -3,7 +3,7 @@
 <plist version="1.0">
 <dict>
 	<key>BuildMachineOSBuild</key>
-	<string>15C50</string>
+	<string>15E65</string>
 	<key>CFBundleDevelopmentRegion</key>
 	<string>en</string>
 	<key>CFBundleExecutable</key>
@@ -17,7 +17,7 @@
 	<key>CFBundlePackageType</key>
 	<string>FMWK</string>
 	<key>CFBundleShortVersionString</key>
-	<string>1.0.0</string>
+	<string>1.0.2</string>
 	<key>CFBundleSignature</key>
 	<string>????</string>
 	<key>CFBundleSupportedPlatforms</key>
@@ -29,17 +29,17 @@
 	<key>DTCompiler</key>
 	<string>com.apple.compilers.llvm.clang.1_0</string>
 	<key>DTPlatformBuild</key>
-	<string>7C68</string>
+	<string>7D175</string>
 	<key>DTPlatformVersion</key>
 	<string>GM</string>
 	<key>DTSDKBuild</key>
-	<string>15C43</string>
+	<string>15E60</string>
 	<key>DTSDKName</key>
 	<string>macosx10.11</string>
 	<key>DTXcode</key>
-	<string>0720</string>
+	<string>0730</string>
 	<key>DTXcodeBuild</key>
-	<string>7C68</string>
+	<string>7D175</string>
 	<key>NSHumanReadableCopyright</key>
 	<string>Copyright © 2015 Rob Rix. All rights reserved.</string>
 </dict>

data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/SWXMLHash.framework/Versions/A/Resources/Info.plist

@@ -3,7 +3,7 @@
 <plist version="1.0">
 <dict>
 	<key>BuildMachineOSBuild</key>
-	<string>15C50</string>
+	<string>15E65</string>
 	<key>CFBundleDevelopmentRegion</key>
 	<string>en</string>
 	<key>CFBundleExecutable</key>
@@ -29,17 +29,17 @@
 	<key>DTCompiler</key>
 	<string>com.apple.compilers.llvm.clang.1_0</string>
 	<key>DTPlatformBuild</key>
-	<string>7C68</string>
+	<string>7D175</string>
 	<key>DTPlatformVersion</key>
 	<string>GM</string>
 	<key>DTSDKBuild</key>
-	<string>15C43</string>
+	<string>15E60</string>
 	<key>DTSDKName</key>
 	<string>macosx10.11</string>
 	<key>DTXcode</key>
-	<string>0720</string>
+	<string>0730</string>
 	<key>DTXcodeBuild</key>
-	<string>7C68</string>
+	<string>7D175</string>
 	<key>UIDeviceFamily</key>
 	<array>
 		<integer>1</integer>