jazzy 0.9.6 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7723d71fdd04817497ff84b517c5d413b43857f56167f3fc96a6de3e082e9cf3
-  data.tar.gz: e9c0a9283b79b76ecaece6ed35d3d323ffafb370d228f4fcc3e00c81876a6fac
+  metadata.gz: b8b0a6f32e8d7182725eafedb4ec488e382de192af903fb42ee9d7cd3c7396c3
+  data.tar.gz: 1b2dbf01dae14692d0a04a1912f71d98cc44d2397fe81280df0d072089b3ad4b
 SHA512:
-  metadata.gz: d3d6685a6ca5b1eea07b0775bd0368f4f259e0325fb68f08a24d9ac1d8855b9759feeaad387d34fbd7201cfb61c031f31723fbe3fa65a236fffb01ac422fbb99
-  data.tar.gz: cc8b9d21b5876440a0a2858791a5e516f550d805b22b41def851921814ff96748880bfab5d613f22297d7570fdb6bd82462eac3597defff8f4464a6b93835164
+  metadata.gz: 04ef74edf753cb424bfe2b9f8bdc7860b3d9072e91a5be60a7db38981d705cc595286a33d805482129746b4ee6626ef5852cbbf13e428d0e0f7fcd99310adf14
+  data.tar.gz: 8b038aaabd0516983b87d80841e1dc490b35e6493cae241193d07b09c946f8f47dd0b7b84bd20300fd382d522ad6ca3104fb2478c9eb6ab764afb5a6840014b4

data/.circleci/config.yml

@@ -12,25 +12,16 @@ aliases:
     BUNDLE_RETRY: 3
     BUNDLE_PATH: vendor/bundle
 
-  - &shell
-    /bin/bash --login -eo pipefail
-
-  - &set-ruby-version
-    echo "ruby-2.4" > ~/.ruby-version
-
 version: 2
 jobs:
 
   swift:
     macos:
-      xcode: "10.2.0"
+      xcode: "11.2.0"
     environment: *bundler-environment
-    # Used to invoke chruby
-    shell: *shell
     steps:
       - checkout
       - restore_cache: *restore-mac-bundler-cache
-      - run: *set-ruby-version
       - run: bundle install
       - run: git submodule update --init --recursive
       - run: bundle exec rake swift_spec
@@ -38,14 +29,11 @@ jobs:
 
   objc:
     macos:
-      xcode: "10.2.0"
+      xcode: "11.2.0"
     environment: *bundler-environment
-    # Used to invoke chruby
-    shell: *shell
     steps:
       - checkout
       - restore_cache: *restore-mac-bundler-cache
-      - run: *set-ruby-version
       - run: bundle install
       - run: git submodule update --init --recursive
       - run: bundle exec rake objc_spec
@@ -53,16 +41,13 @@ jobs:
 
   cocoapods:
     macos:
-      xcode: "10.2.0"
+      xcode: "11.2.0"
     environment: *bundler-environment
-    # Used to invoke chruby
-    shell: *shell
     steps:
       - checkout
       - restore_cache:
           key: cocoapods
       - restore_cache: *restore-mac-bundler-cache
-      - run: *set-ruby-version
       - run: bundle install
       - run: git submodule update --init --recursive
       - run: bundle exec rake cocoapods_spec
@@ -76,8 +61,6 @@ jobs:
     docker:
       - image: circleci/ruby:2.4-node
         environment: *bundler-environment
-        # Used to invoke chruby
-        shell: *shell
     steps:
       - checkout
       - restore_cache:

data/CHANGELOG.md

@@ -1,3 +1,153 @@
+## 0.12.0
+
+##### Breaking
+
+* None.
+
+##### Enhancements
+
+* Support for mixed Swift-ObjC modules: generate two sets of SourceKitten
+  json and pass them on using `--sourcekitten-sourcefile`.  
+  [Joe Susnick](https://github.com/joesus)
+  [John Fairhurst](https://github.com/johnfairh)
+  [#447](https://github.com/realm/jazzy/issues/447)
+
+##### Bug Fixes
+
+* Stop displaying type attributes on extension declarations.  
+  [John Fairhurst](https://github.com/johnfairh)
+
+* Show ObjC and Swift classes (etc.) in the same category.  
+  [John Fairhurst](https://github.com/johnfairh)
+
+* Merge Swift extensions into ObjC classes.  
+  [John Fairhurst](https://github.com/johnfairh)
+  [Joe Susnick](https://github.com/joesus)
+
+## 0.11.2
+
+##### Breaking
+
+* None.
+
+##### Enhancements
+
+* None.
+
+##### Bug Fixes
+
+* Generate Swift docs with Xcode 11 and paths with spaces.  
+  [John Fairhurst](https://github.com/johnfairh)
+  [#1108](https://github.com/realm/jazzy/issues/1108)
+
+* Reinstate guessing of module name from podspec, broken in 0.11.0.  
+  [John Fairhurst](https://github.com/johnfairh)
+  [#1109](https://github.com/realm/jazzy/issues/1109)
+
+## 0.11.1
+
+##### Breaking
+
+* None.
+
+##### Enhancements
+
+* None.
+
+##### Bug Fixes
+
+* Don't use SwiftPM if there is an Xcode workspace or project in a non-root
+  directory.  
+  [John Fairhurst](https://github.com/johnfairh)
+  [#1103](https://github.com/realm/jazzy/issues/1103)
+
+## 0.11.0
+
+##### Breaking
+
+* None.
+
+##### Enhancements
+
+* Sass support now provided by `libsass` via `sassc` instead of the
+  deprecated Ruby Sass gem.  
+  [John Fairhurst](https://github.com/johnfairh)
+
+* Update bundled jQuery to 3.4.1 (all themes).  
+  [Paul Idstein](https://github.com/idstein)
+
+* Support Xcode 11 Swift projects that pass a response file to the Swift
+  compiler.  
+  [John Fairhurst](https://github.com/johnfairh)
+  [#1087](https://github.com/realm/jazzy/issues/1087)
+
+* Generate Swift docs from a Swift Package Manager package without
+  requiring an Xcode project file.  Add `--swift-build-tool` to choose
+  the build method if both `.xcodeproj` and `Package.swift` files are
+  present.  Add `--build-tool-flags` as a preferred alias for
+  `--xcodebuild-flags`.  
+  [John Fairhurst](https://github.com/johnfairh)
+  [#487](https://github.com/realm/jazzy/issues/487)
+
+##### Bug Fixes
+
+* Preserve non-latin characters in guide filenames and heading IDs.  
+  [John Fairhurst](https://github.com/johnfairh)
+  [#1091](https://github.com/realm/jazzy/issues/1091)
+
+* Generate correct html for custom categories containing special
+  characters.  
+  [John Fairhurst](https://github.com/johnfairh)
+  [#945](https://github.com/realm/jazzy/issues/945)
+
+* Fix crash on files with misplaced documentation comments.  
+  [John Fairhurst](https://github.com/johnfairh)
+  [#1083](https://github.com/realm/jazzy/issues/1083)
+
+## 0.10.0
+
+##### Breaking
+
+* The included `sourcekitten` binary is built with Xcode 10.2.  This means
+  it does not run on macOS earlier than 10.14.4 without the *Swift 5 Runtime
+  Support for Command Line Tools* being installed.  
+  [John Fairhurst](https://github.com/johnfairh)
+
+##### Enhancements
+
+* Support CocoaPods 1.6+.  Use the `swift_version[s]` dsl in `--podspec` mode
+  to set the Swift language version.  
+  [John Fairhurst](https://github.com/johnfairh)
+
+* Show the extension declaration when documenting Swift extensions.  
+  [John Fairhurst](https://github.com/johnfairh)
+
+* Allow docs title customization.  Include `--module-version` when it is set
+  and support `--title` to fully customize the title.  Pass `{{module_version}}`
+  and `{{docs_title}}` to templates.  
+  [Maximilian Alexander](https://github.com/mbalex99)
+  [John Fairhurst](https://github.com/johnfairh)
+  [#666](https://github.com/realm/jazzy/issues/666)
+  [#411](https://github.com/realm/jazzy/issues/411)
+
+##### Bug Fixes
+
+* Unfold member documentation when linked to from current web page.  
+  [John Fairhurst](https://github.com/johnfairh)
+  [#788](https://github.com/realm/jazzy/issues/788)
+
+* Generate docs when there are unusual characters in source pathnames.  
+  [John Fairhurst](https://github.com/johnfairh)
+  [#1049](https://github.com/realm/jazzy/issues/1049)
+
+* Generate docs for signed modules with Xcode 10.2.  
+  [John Fairhurst](https://github.com/johnfairh)
+  [#1057](https://github.com/realm/jazzy/issues/1057)
+
+* Use correct module name when only target name is supplied.  
+  [Chris Zielinski](https://github.com/chriszielinski)
+  [#422](https://github.com/realm/jazzy/issues/422)
+
 ## 0.9.6
 
 This is (probably) the last release to support Ruby earlier than 2.3.

data/CONTRIBUTING.md

@@ -49,7 +49,7 @@ git push
 You'll need push access to the integration specs repo to do this. You can
 request access from one of the maintainers when filing your PR.
 
-You must have Xcode 10.2 installed to build the integration specs.
+You must have Xcode 11.2 installed to build the integration specs.
 
 ## Making changes to SourceKitten
 

data/Gemfile.lock

@@ -1,31 +1,34 @@
 PATH
   remote: .
   specs:
-    jazzy (0.9.6)
-      cocoapods (~> 1.5.3)
-      mustache (~> 1.1.0)
+    jazzy (0.12.0)
+      cocoapods (~> 1.5)
+      mustache (~> 1.1)
       open4
-      redcarpet (~> 3.4.0)
+      redcarpet (~> 3.4)
       rouge (>= 2.0.6, < 4.0)
-      sass (~> 3.6.0)
-      sqlite3 (~> 1.3.13)
+      sassc (~> 2.1)
+      sqlite3 (~> 1.3)
       xcinvoke (~> 0.3.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    CFPropertyList (3.0.0)
+    CFPropertyList (3.0.1)
     activesupport (4.2.11.1)
       i18n (~> 0.7)
       minitest (~> 5.1)
       thread_safe (~> 0.3, >= 0.3.4)
       tzinfo (~> 1.1)
-    addressable (2.5.2)
-      public_suffix (>= 2.0.2, < 4.0)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    algoliasearch (1.27.1)
+      httpclient (~> 2.8, >= 2.8.3)
+      json (>= 1.5.1)
     ast (2.4.0)
     atomos (0.1.3)
     bacon (1.2.0)
-    claide (1.0.2)
+    claide (1.0.3)
     claide-plugins (0.9.2)
       cork
       nap
@@ -33,27 +36,29 @@ GEM
     clintegracon (0.7.0)
       colored (~> 1.2)
       diffy
-    cocoapods (1.5.3)
+    cocoapods (1.8.4)
       activesupport (>= 4.0.2, < 5)
       claide (>= 1.0.2, < 2.0)
-      cocoapods-core (= 1.5.3)
-      cocoapods-deintegrate (>= 1.0.2, < 2.0)
-      cocoapods-downloader (>= 1.2.0, < 2.0)
+      cocoapods-core (= 1.8.4)
+      cocoapods-deintegrate (>= 1.0.3, < 2.0)
+      cocoapods-downloader (>= 1.2.2, < 2.0)
       cocoapods-plugins (>= 1.0.0, < 2.0)
       cocoapods-search (>= 1.0.0, < 2.0)
       cocoapods-stats (>= 1.0.0, < 2.0)
-      cocoapods-trunk (>= 1.3.0, < 2.0)
+      cocoapods-trunk (>= 1.4.0, < 2.0)
       cocoapods-try (>= 1.1.0, < 2.0)
       colored2 (~> 3.1)
       escape (~> 0.0.4)
-      fourflusher (~> 2.0.1)
+      fourflusher (>= 2.3.0, < 3.0)
       gh_inspector (~> 1.0)
-      molinillo (~> 0.6.5)
+      molinillo (~> 0.6.6)
       nap (~> 1.0)
-      ruby-macho (~> 1.1)
-      xcodeproj (>= 1.5.7, < 2.0)
-    cocoapods-core (1.5.3)
+      ruby-macho (~> 1.4)
+      xcodeproj (>= 1.11.1, < 2.0)
+    cocoapods-core (1.8.4)
       activesupport (>= 4.0.2, < 6)
+      algoliasearch (~> 1.0)
+      concurrent-ruby (~> 1.1)
       fuzzy_match (~> 2.0.4)
       nap (~> 1.0)
     cocoapods-deintegrate (1.0.4)
@@ -62,7 +67,7 @@ GEM
       nap
     cocoapods-search (1.0.0)
     cocoapods-stats (1.1.0)
-    cocoapods-trunk (1.3.1)
+    cocoapods-trunk (1.4.1)
       nap (>= 0.8, < 2.0)
       netrc (~> 0.11)
     cocoapods-try (1.1.0)
@@ -73,13 +78,13 @@ GEM
       colored2 (~> 3.1)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
-    danger (6.0.2)
+    danger (6.1.0)
       claide (~> 1.0)
       claide-plugins (>= 0.9.2)
       colored2 (~> 3.1)
       cork (~> 0.1)
       faraday (~> 0.9)
-      faraday-http-cache (~> 1.0)
+      faraday-http-cache (~> 2.0)
       git (~> 1.5)
       kramdown (~> 2.0)
       kramdown-parser-gfm (~> 1.0)
@@ -88,30 +93,32 @@ GEM
       terminal-table (~> 1)
     diffy (3.3.0)
     escape (0.0.4)
-    faraday (0.15.4)
+    faraday (0.17.0)
       multipart-post (>= 1.2, < 3)
-    faraday-http-cache (1.3.1)
+    faraday-http-cache (2.0.0)
       faraday (~> 0.8)
-    ffi (1.10.0)
-    fourflusher (2.0.1)
+    ffi (1.11.1)
+    fourflusher (2.3.1)
     fuzzy_match (2.0.4)
     gh_inspector (1.1.3)
     git (1.5.0)
-    hashdiff (0.3.8)
+    hashdiff (1.0.0)
+    httpclient (2.8.3)
     i18n (0.9.5)
       concurrent-ruby (~> 1.0)
+    json (2.2.0)
     kramdown (2.1.0)
-    kramdown-parser-gfm (1.0.1)
+    kramdown-parser-gfm (1.1.0)
       kramdown (~> 2.0)
     liferaft (0.0.6)
     metaclass (0.0.4)
-    minitest (5.11.3)
-    mocha (1.8.0)
+    minitest (5.13.0)
+    mocha (1.9.0)
       metaclass (~> 0.0.1)
     mocha-on-bacon (0.2.3)
       mocha (>= 0.13.0)
     molinillo (0.6.6)
-    multipart-post (2.0.0)
+    multipart-post (2.1.1)
     mustache (1.1.0)
     nanaimo (0.2.6)
     nap (1.1.0)
@@ -120,21 +127,18 @@ GEM
     octokit (4.14.0)
       sawyer (~> 0.8.0, >= 0.5.3)
     open4 (1.3.4)
-    parallel (1.17.0)
-    parser (2.6.2.0)
+    parallel (1.18.0)
+    parser (2.6.5.0)
       ast (~> 2.4.0)
     powerpack (0.1.2)
     prettybacon (0.0.2)
       bacon (~> 1.2)
-    public_suffix (3.0.3)
+    public_suffix (4.0.1)
     rainbow (2.2.2)
       rake
     rake (10.5.0)
-    rb-fsevent (0.10.3)
-    rb-inotify (0.10.0)
-      ffi (~> 1.0)
-    redcarpet (3.4.0)
-    rouge (3.3.0)
+    redcarpet (3.5.0)
+    rouge (3.12.0)
     rubocop (0.49.0)
       parallel (~> 1.10)
       parser (>= 2.3.3.1, < 3.0)
@@ -143,30 +147,27 @@ GEM
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.0, >= 1.0.1)
     ruby-macho (1.4.0)
-    ruby-progressbar (1.10.0)
+    ruby-progressbar (1.10.1)
     safe_yaml (1.0.5)
-    sass (3.6.0)
-      sass-listen (~> 4.0.0)
-    sass-listen (4.0.0)
-      rb-fsevent (~> 0.9, >= 0.9.4)
-      rb-inotify (~> 0.9, >= 0.9.7)
-    sawyer (0.8.1)
-      addressable (>= 2.3.5, < 2.6)
-      faraday (~> 0.8, < 1.0)
-    sqlite3 (1.3.13)
+    sassc (2.2.1)
+      ffi (~> 1.9)
+    sawyer (0.8.2)
+      addressable (>= 2.3.5)
+      faraday (> 0.8, < 2.0)
+    sqlite3 (1.4.1)
     terminal-table (1.8.0)
       unicode-display_width (~> 1.1, >= 1.1.1)
     thread_safe (0.3.6)
     tzinfo (1.2.5)
       thread_safe (~> 0.1)
-    unicode-display_width (1.5.0)
-    webmock (3.5.1)
+    unicode-display_width (1.6.0)
+    webmock (3.7.6)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
-      hashdiff
+      hashdiff (>= 0.4.0, < 2.0.0)
     xcinvoke (0.3.0)
       liferaft (~> 0.0.6)
-    xcodeproj (1.8.2)
+    xcodeproj (1.13.0)
       CFPropertyList (>= 2.3.3, < 4.0)
       atomos (~> 0.1.3)
       claide (>= 1.0.2, < 2.0)