jazzy 0.13.6 → 0.13.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 20ab471420ed44e905319be51f0410c0571efa3f56902834b6e7d47f4f66fd0a
-  data.tar.gz: 2bfa14b53c563edb51d4cf0f0a4041859929561b725324761f17568410819838
+  metadata.gz: 63788e011ffdb57c019f0bd8f06892fbc47303f10d57407e8487e5c4d070c761
+  data.tar.gz: d93e4603a15f4c5695bab995c3fc99fbeb7fd463e97a41806c9e6fa7c563fc05
 SHA512:
-  metadata.gz: 6c5b2eeb4b88f7cf4c8b406bc627c754b50f7f95cd9c555127998530e201b7dfc0e86c237cff3f3dff71c85fa6c979733e0b75de6fd4c52333de8e9d9cf741b0
-  data.tar.gz: 672470f7c618f5fc659035a2705674b3804558abc86d58c788943f1495e7e4e3de9447ae6ee46156b68c11776d32986551c91a7f7b222fda455e59f89bc91973
+  metadata.gz: d73ba88867dcb2f32d7358b367ab24ac086bceccf02aa74e18b2d17e6d70870a4831fbbbfb6027af8a99e4ddc8db737fefbfe60580924a9367d5b11a472b0b12
+  data.tar.gz: 61f9af01c7fd7b2293e9d91cb60063c8fc5e95281815e7a8ff11bc2a80fdbf514264a4d4fada6fc29ad7e97859e18b9d17a3cf2649a1b1f5aa0bd9cb24e22276

data/.github/workflows/Tests.yml

@@ -0,0 +1,52 @@
+name: Tests
+  
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: ['*']
+
+jobs:
+  danger_and_rubocop:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.5
+          bundler-cache: true
+      - name: Danger
+        env:
+          DANGER_GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          bundle exec danger --verbose
+      - name: Rubocop
+        run: |
+          bundle exec rake rubocop
+
+  spec:
+    runs-on: macos-11.0
+    continue-on-error: true
+    strategy:
+      matrix:
+        spec: ["objc_spec", "swift_spec", "cocoapods_spec"]
+    env:
+      DEVELOPER_DIR: /Applications/Xcode_12.5.app/Contents/Developer
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          submodules: recursive
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.6
+          bundler-cache: true
+      - name: Cache cocoapods
+        uses: actions/cache@v2
+        env:
+          cache-name: cocoapods
+        with:
+          path: ~/.cocoapods
+          key: ${{ matrix.spec }}-${{ env.cache-name }}
+      - name: Test
+        run: |
+          bundle exec rake ${{ matrix.spec }}

data/CHANGELOG.md

@@ -1,3 +1,27 @@
+## 0.13.7
+
+The next release of Jazzy will require a minimum of Ruby 2.6.
+
+##### Breaking
+
+* None.
+
+##### Enhancements
+
+* Update JavaScript libraries: jQuery 3.6.0, Lunr 2.3.9,
+  KaTeX 0.13.5.  
+  [John Fairhurst](https://github.com/johnfairh)
+
+* Support the markdown [footnotes](https://www.markdownguide.org/extended-syntax/#footnotes) extension in all themes.  
+  [John Fairhurst](https://github.com/johnfairh)
+  [#1246](https://github.com/realm/jazzy/issues/1246)
+
+##### Bug Fixes
+
+* Fix parameter doc comments in Swift symbolgraph mode.  
+  [John Fairhurst](https://github.com/johnfairh)
+  [#1244](https://github.com/realm/jazzy/issues/1244)
+
 ## 0.13.6
 
 ##### Breaking

data/CONTRIBUTING.md

@@ -13,12 +13,12 @@ the `CHANGELOG.md` file.
 
 We follow the same syntax as CocoaPods' CHANGELOG.md:
 
-1. One Markdown unnumbered list item desribing the change.
-2. 2 trailing spaces on the last line describing the change.
+1. One Markdown unnumbered list item describing the change.
+2. Two trailing spaces on the last line describing the change.
 3. A list of Markdown hyperlinks to the contributors to the change. One entry
-   per line. Usually just one.
+   per line (and there's usually just one contributor).
 4. A list of Markdown hyperlinks to the issues the change addresses. One entry
-   per line. Usually just one. Don't link to PRs here.
+   per line (and there's usually just one hyperlink). Don't link to PRs here.
 5. All CHANGELOG.md content is hard-wrapped at 80 characters.
 
 ## Updating the integration specs
@@ -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 11.4 installed to build the integration specs.
+You must have Xcode 12.5 installed to build the integration specs.
 
 ## Making changes to SourceKitten
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    jazzy (0.13.6)
+    jazzy (0.13.7)
       cocoapods (~> 1.5)
       mustache (~> 1.1)
       open4
@@ -14,8 +14,8 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    CFPropertyList (3.0.2)
-    activesupport (5.2.4.4)
+    CFPropertyList (3.0.3)
+    activesupport (5.2.6)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
@@ -25,7 +25,7 @@ GEM
     algoliasearch (1.27.5)
       httpclient (~> 2.8, >= 2.8.3)
       json (>= 1.5.1)
-    ast (2.4.1)
+    ast (2.4.2)
     atomos (0.1.3)
     bacon (1.2.0)
     claide (1.0.3)
@@ -36,10 +36,10 @@ GEM
     clintegracon (0.7.0)
       colored (~> 1.2)
       diffy
-    cocoapods (1.10.0)
+    cocoapods (1.10.1)
       addressable (~> 2.6)
       claide (>= 1.0.2, < 2.0)
-      cocoapods-core (= 1.10.0)
+      cocoapods-core (= 1.10.1)
       cocoapods-deintegrate (>= 1.0.3, < 2.0)
       cocoapods-downloader (>= 1.4.0, < 2.0)
       cocoapods-plugins (>= 1.0.0, < 2.0)
@@ -54,7 +54,7 @@ GEM
       nap (~> 1.0)
       ruby-macho (~> 1.4)
       xcodeproj (>= 1.19.0, < 2.0)
-    cocoapods-core (1.10.0)
+    cocoapods-core (1.10.1)
       activesupport (> 5.0, < 6)
       addressable (~> 2.6)
       algoliasearch (~> 1.0)
@@ -75,11 +75,12 @@ GEM
     cocoapods-try (1.2.0)
     colored (1.2)
     colored2 (3.1.2)
-    concurrent-ruby (1.1.7)
+    concurrent-ruby (1.1.8)
     cork (0.3.0)
       colored2 (~> 3.1)
-    crack (0.4.4)
-    danger (8.2.0)
+    crack (0.4.5)
+      rexml
+    danger (8.2.3)
       claide (~> 1.0)
       claide-plugins (>= 0.9.2)
       colored2 (~> 3.1)
@@ -91,34 +92,40 @@ GEM
       kramdown-parser-gfm (~> 1.0)
       no_proxy_fix
       octokit (~> 4.7)
-      terminal-table (~> 1)
+      terminal-table (>= 1, < 4)
     diffy (3.4.0)
     escape (0.0.4)
-    ethon (0.12.0)
-      ffi (>= 1.3.0)
-    faraday (1.1.0)
+    ethon (0.14.0)
+      ffi (>= 1.15.0)
+    faraday (1.4.1)
+      faraday-excon (~> 1.1)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.1)
       multipart-post (>= 1.2, < 3)
-      ruby2_keywords
+      ruby2_keywords (>= 0.0.4)
+    faraday-excon (1.1.0)
     faraday-http-cache (2.2.0)
       faraday (>= 0.8)
-    ffi (1.13.1)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.1.0)
+    ffi (1.15.0)
     fourflusher (2.3.1)
     fuzzy_match (2.0.4)
     gh_inspector (1.1.3)
-    git (1.7.0)
+    git (1.8.1)
       rchardet (~> 1.8)
     hashdiff (1.0.1)
     httpclient (2.8.3)
-    i18n (1.8.5)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
-    json (2.3.1)
-    kramdown (2.3.0)
+    json (2.5.1)
+    kramdown (2.3.1)
       rexml
     kramdown-parser-gfm (1.1.0)
       kramdown (~> 2.0)
     liferaft (0.0.6)
-    minitest (5.14.2)
-    mocha (1.11.2)
+    minitest (5.14.4)
+    mocha (1.12.0)
     mocha-on-bacon (0.2.3)
       mocha (>= 0.13.0)
     molinillo (0.6.6)
@@ -128,24 +135,24 @@ GEM
     nap (1.1.0)
     netrc (0.11.0)
     no_proxy_fix (0.1.2)
-    octokit (4.19.0)
+    octokit (4.21.0)
       faraday (>= 0.9)
       sawyer (~> 0.8.0, >= 0.5.3)
     open4 (1.3.4)
-    parallel (1.20.0)
+    parallel (1.20.1)
     parser (2.7.2.0)
       ast (~> 2.4.1)
-    powerpack (0.1.2)
+    powerpack (0.1.3)
     prettybacon (0.0.2)
       bacon (~> 1.2)
     public_suffix (4.0.6)
     rainbow (2.2.2)
       rake
-    rake (13.0.1)
+    rake (13.0.3)
     rchardet (1.8.0)
-    redcarpet (3.5.0)
-    rexml (3.2.4)
-    rouge (3.24.0)
+    redcarpet (3.5.1)
+    rexml (3.2.5)
+    rouge (3.26.0)
     rubocop (0.49.0)
       parallel (~> 1.10)
       parser (>= 2.3.3.1, < 3.0)
@@ -154,23 +161,23 @@ GEM
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.0, >= 1.0.1)
     ruby-macho (1.4.0)
-    ruby-progressbar (1.10.1)
-    ruby2_keywords (0.0.2)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.4)
     sassc (2.4.0)
       ffi (~> 1.9)
     sawyer (0.8.2)
       addressable (>= 2.3.5)
       faraday (> 0.8, < 2.0)
     sqlite3 (1.4.2)
-    terminal-table (1.8.0)
+    terminal-table (3.0.0)
       unicode-display_width (~> 1.1, >= 1.1.1)
     thread_safe (0.3.6)
     typhoeus (1.4.0)
       ethon (>= 0.9.0)
-    tzinfo (1.2.8)
+    tzinfo (1.2.9)
       thread_safe (~> 0.1)
     unicode-display_width (1.7.0)
-    webmock (3.9.4)
+    webmock (3.12.2)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)

data/README.md

@@ -1,6 +1,6 @@
 ![jazzy](images/logo.jpg)
 
-[![Build Status](https://circleci.com/gh/realm/jazzy.svg?style=svg)](https://circleci.com/gh/realm/jazzy)
+[![Build Status](https://github.com/realm/jazzy/actions/workflows/Tests.yml/badge.svg)](https://github.com/realm/jazzy/actions/workflows/Tests.yml)
 
 *jazzy is a command-line utility that generates documentation for Swift or Objective-C*
 

data/js/package-lock.json

@@ -1,39 +1,44 @@
 {
-  "name": "jazzy-js",
-  "version": "1.0.0",
-  "lockfileVersion": 1,
+  "lockfileVersion": 2,
   "requires": true,
-  "dependencies": {
-    "commander": {
-      "version": "2.20.3",
-      "resolved": "https://registry.npmjs.org/commander/-/commander-2.20.3.tgz",
-      "integrity": "sha512-GpVkmM8vF2vQUkj2LvZmD35JxeJOLCwJ9cUkugyk2nuhbv3+mJvpLYYt+0+USMxE+oj+ey/lJEnhZw75x/OMcQ=="
+  "packages": {
+    "node_modules/commander": {
+      "version": "6.2.1",
+      "resolved": "https://registry.npmjs.org/commander/-/commander-6.2.1.tgz",
+      "integrity": "sha512-U7VdrJFnJgo4xjrHpTzu0yrHPGImdsmD95ZlgYSEajAn2JKzDhDTPG9kBTefmObL2w/ngeZnilk+OV9CG3d7UA==",
+      "engines": {
+        "node": ">= 6"
+      }
     },
-    "corejs-typeahead": {
+    "node_modules/corejs-typeahead": {
       "version": "1.3.1",
       "resolved": "https://registry.npmjs.org/corejs-typeahead/-/corejs-typeahead-1.3.1.tgz",
       "integrity": "sha512-fyNlBNWJNL6EQUnJyAunEzBzRcwR2cEHtZXBi2pndHPOJ/wpOf3wbS+/Oh+kYYS5sKowQcs0LFwMSl6Y2Xeqkw==",
-      "requires": {
+      "dependencies": {
         "jquery": ">=1.11"
       }
     },
-    "jquery": {
-      "version": "3.5.1",
-      "resolved": "https://registry.npmjs.org/jquery/-/jquery-3.5.1.tgz",
-      "integrity": "sha512-XwIBPqcMn57FxfT+Go5pzySnm4KWkT1Tv7gjrpT1srtf8Weynl6R273VJ5GjkRb51IzMp5nbaPjJXMWeju2MKg=="
+    "node_modules/jquery": {
+      "version": "3.6.0",
+      "resolved": "https://registry.npmjs.org/jquery/-/jquery-3.6.0.tgz",
+      "integrity": "sha512-JVzAR/AjBvVt2BmYhxRCSYysDsPcssdmTFnzyLEts9qNwmjmu4JTAMYubEfwVOSwpQ1I1sKKFcxhZCI2buerfw=="
     },
-    "katex": {
-      "version": "0.11.1",
-      "resolved": "https://registry.npmjs.org/katex/-/katex-0.11.1.tgz",
-      "integrity": "sha512-5oANDICCTX0NqYIyAiFCCwjQ7ERu3DQG2JFHLbYOf+fXaMoH8eg/zOq5WSYJsKMi/QebW+Eh3gSM+oss1H/bww==",
-      "requires": {
-        "commander": "^2.19.0"
+    "node_modules/katex": {
+      "version": "0.13.5",
+      "resolved": "https://registry.npmjs.org/katex/-/katex-0.13.5.tgz",
+      "integrity": "sha512-n2uEzFpNFUOAlWs0eCgmT82LQyP+BlS45yBgnLRqe+ENp3+FEM3lM+cJwZwwxxONFgayyq1fm6n+w35vo2MaUg==",
+      "dependencies": {
+        "commander": "^6.0.0"
+      },
+      "bin": {
+        "katex": "cli.js"
       }
     },
-    "lunr": {
-      "version": "2.3.8",
-      "resolved": "https://registry.npmjs.org/lunr/-/lunr-2.3.8.tgz",
-      "integrity": "sha512-oxMeX/Y35PNFuZoHp+jUj5OSEmLCaIH4KTFJh7a93cHBoFmpw2IoPs22VIz7vyO2YUnx2Tn9dzIwO2P/4quIRg=="
+    "node_modules/lunr": {
+      "version": "2.3.9",
+      "resolved": "https://registry.npmjs.org/lunr/-/lunr-2.3.9.tgz",
+      "integrity": "sha512-zTU3DaZaF3Rt9rhN3uBMGQD3dD2/vFQqnvZCDv4dl5iOzq2IZQqTxu90r4E5J+nP70J3ilqVCrbho2eWaeW8Ow=="
     }
-  }
+  },
+  "dependencies": {}
 }

data/js/package.json

@@ -10,8 +10,8 @@
   "license": "MIT",
   "dependencies": {
     "corejs-typeahead": "^1.3.1",
-    "jquery": "^3.5.1",
-    "katex": "^0.11.1",
-    "lunr": "^2.3.8"
+    "jquery": "^3.6.0",
+    "katex": "^0.13.3",
+    "lunr": "^2.3.9"
   }
 }

data/lib/jazzy/config.rb

@@ -253,7 +253,7 @@ module Jazzy
 
     config_attr :version,
       command_line: '--module-version VERSION',
-      description: 'Version string to use as part of the the default docs '\
+      description: 'Version string to use as part of the default docs '\
                    'title and inside the docset.',
       default: '1.0'