jazzy 0.13.4 → 0.14.0

data/Gemfile

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec
 
 group :development do
   # Code style
-  gem 'rubocop', '0.49.0'
+  gem 'rubocop', '~> 1.18'
 
   # Tests
   gem 'bacon'

data/Gemfile.lock

@@ -1,11 +1,12 @@
 PATH
   remote: .
   specs:
-    jazzy (0.13.4)
+    jazzy (0.14.0)
       cocoapods (~> 1.5)
       mustache (~> 1.1)
-      open4
+      open4 (~> 1.3)
       redcarpet (~> 3.4)
+      rexml (~> 3.2)
       rouge (>= 2.0.6, < 4.0)
       sassc (~> 2.1)
       sqlite3 (~> 1.3)
@@ -14,18 +15,18 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    CFPropertyList (3.0.2)
-    activesupport (4.2.11.3)
-      i18n (~> 0.7)
+    CFPropertyList (3.0.3)
+    activesupport (5.2.6)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
       minitest (~> 5.1)
-      thread_safe (~> 0.3, >= 0.3.4)
       tzinfo (~> 1.1)
-    addressable (2.7.0)
+    addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
-    algoliasearch (1.27.2)
+    algoliasearch (1.27.5)
       httpclient (~> 2.8, >= 2.8.3)
       json (>= 1.5.1)
-    ast (2.4.0)
+    ast (2.4.2)
     atomos (0.1.3)
     bacon (1.2.0)
     claide (1.0.3)
@@ -36,15 +37,14 @@ GEM
     clintegracon (0.7.0)
       colored (~> 1.2)
       diffy
-    cocoapods (1.9.3)
-      activesupport (>= 4.0.2, < 5)
+    cocoapods (1.10.2)
+      addressable (~> 2.6)
       claide (>= 1.0.2, < 2.0)
-      cocoapods-core (= 1.9.3)
+      cocoapods-core (= 1.10.2)
       cocoapods-deintegrate (>= 1.0.3, < 2.0)
-      cocoapods-downloader (>= 1.2.2, < 2.0)
+      cocoapods-downloader (>= 1.4.0, < 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.4.0, < 2.0)
       cocoapods-try (>= 1.1.0, < 2.0)
       colored2 (~> 3.1)
@@ -54,33 +54,34 @@ GEM
       molinillo (~> 0.6.6)
       nap (~> 1.0)
       ruby-macho (~> 1.4)
-      xcodeproj (>= 1.14.0, < 2.0)
-    cocoapods-core (1.9.3)
-      activesupport (>= 4.0.2, < 6)
+      xcodeproj (>= 1.19.0, < 2.0)
+    cocoapods-core (1.10.2)
+      activesupport (> 5.0, < 6)
+      addressable (~> 2.6)
       algoliasearch (~> 1.0)
       concurrent-ruby (~> 1.1)
       fuzzy_match (~> 2.0.4)
       nap (~> 1.0)
       netrc (~> 0.11)
+      public_suffix
       typhoeus (~> 1.0)
     cocoapods-deintegrate (1.0.4)
-    cocoapods-downloader (1.3.0)
+    cocoapods-downloader (1.4.0)
     cocoapods-plugins (1.0.0)
       nap
-    cocoapods-search (1.0.0)
-    cocoapods-stats (1.1.0)
+    cocoapods-search (1.0.1)
     cocoapods-trunk (1.5.0)
       nap (>= 0.8, < 2.0)
       netrc (~> 0.11)
     cocoapods-try (1.2.0)
     colored (1.2)
     colored2 (3.1.2)
-    concurrent-ruby (1.1.6)
+    concurrent-ruby (1.1.9)
     cork (0.3.0)
       colored2 (~> 3.1)
-    crack (0.4.3)
-      safe_yaml (~> 1.0.0)
-    danger (8.0.0)
+    crack (0.4.5)
+      rexml
+    danger (8.3.1)
       claide (~> 1.0)
       claide-plugins (>= 0.9.2)
       colored2 (~> 3.1)
@@ -88,107 +89,128 @@ GEM
       faraday (>= 0.9.0, < 2.0)
       faraday-http-cache (~> 2.0)
       git (~> 1.7)
-      kramdown (~> 2.0)
+      kramdown (~> 2.3)
       kramdown-parser-gfm (~> 1.0)
       no_proxy_fix
       octokit (~> 4.7)
-      terminal-table (~> 1)
-    diffy (3.3.0)
+      terminal-table (>= 1, < 4)
+    diffy (3.4.0)
     escape (0.0.4)
-    ethon (0.12.0)
-      ffi (>= 1.3.0)
-    faraday (1.0.1)
+    ethon (0.14.0)
+      ffi (>= 1.15.0)
+    faraday (1.7.0)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0.1)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.1)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
       multipart-post (>= 1.2, < 3)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
     faraday-http-cache (2.2.0)
       faraday (>= 0.8)
-    ffi (1.12.2)
+    faraday-httpclient (1.0.1)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    ffi (1.15.3)
     fourflusher (2.3.1)
     fuzzy_match (2.0.4)
     gh_inspector (1.1.3)
-    git (1.7.0)
+    git (1.9.1)
       rchardet (~> 1.8)
     hashdiff (1.0.1)
     httpclient (2.8.3)
-    i18n (0.9.5)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
-    json (2.3.0)
-    kramdown (2.2.1)
+    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.1)
-    mocha (1.11.2)
+    minitest (5.14.4)
+    mocha (1.13.0)
     mocha-on-bacon (0.2.3)
       mocha (>= 0.13.0)
     molinillo (0.6.6)
     multipart-post (2.1.1)
     mustache (1.1.1)
-    nanaimo (0.2.6)
+    nanaimo (0.3.0)
     nap (1.1.0)
     netrc (0.11.0)
     no_proxy_fix (0.1.2)
-    octokit (4.18.0)
+    octokit (4.21.0)
       faraday (>= 0.9)
       sawyer (~> 0.8.0, >= 0.5.3)
     open4 (1.3.4)
-    parallel (1.19.1)
-    parser (2.7.1.3)
-      ast (~> 2.4.0)
-    powerpack (0.1.2)
+    parallel (1.20.1)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
     prettybacon (0.0.2)
       bacon (~> 1.2)
-    public_suffix (4.0.5)
-    rainbow (2.2.2)
-      rake
-    rake (13.0.1)
+    public_suffix (4.0.6)
+    rainbow (3.0.0)
+    rake (13.0.6)
     rchardet (1.8.0)
-    redcarpet (3.5.0)
-    rexml (3.2.4)
-    rouge (3.19.0)
-    rubocop (0.49.0)
+    redcarpet (3.5.1)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rouge (3.26.0)
+    rubocop (1.19.0)
       parallel (~> 1.10)
-      parser (>= 2.3.3.1, < 3.0)
-      powerpack (~> 0.1)
-      rainbow (>= 1.99.1, < 3.0)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.9.1, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (~> 1.0, >= 1.0.1)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.10.0)
+      parser (>= 3.0.1.1)
     ruby-macho (1.4.0)
-    ruby-progressbar (1.10.1)
-    safe_yaml (1.0.5)
-    sassc (2.3.0)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
+    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)
-      unicode-display_width (~> 1.1, >= 1.1.1)
+    terminal-table (3.0.1)
+      unicode-display_width (>= 1.1.1, < 3)
     thread_safe (0.3.6)
     typhoeus (1.4.0)
       ethon (>= 0.9.0)
-    tzinfo (1.2.7)
+    tzinfo (1.2.9)
       thread_safe (~> 0.1)
-    unicode-display_width (1.7.0)
-    webmock (3.8.3)
-      addressable (>= 2.3.6)
+    unicode-display_width (2.0.0)
+    webmock (3.14.0)
+      addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
     xcinvoke (0.3.0)
       liferaft (~> 0.0.6)
-    xcodeproj (1.16.0)
+    xcodeproj (1.21.0)
       CFPropertyList (>= 2.3.3, < 4.0)
       atomos (~> 0.1.3)
       claide (>= 1.0.2, < 2.0)
       colored2 (~> 3.1)
-      nanaimo (~> 0.2.6)
+      nanaimo (~> 0.3.0)
+      rexml (~> 3.2.4)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bacon
-  bundler (~> 1.7)
+  bundler (~> 2.1)
   clintegracon (= 0.7.0)
   danger
   diffy
@@ -197,8 +219,8 @@ DEPENDENCIES
   mocha-on-bacon
   prettybacon
   rake (~> 13.0)
-  rubocop (= 0.49.0)
+  rubocop (~> 1.18)
   webmock
 
 BUNDLED WITH
-   1.17.3
+   2.2.22

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*
 
@@ -8,13 +8,14 @@
 
 Both Swift and Objective-C projects are supported.
 
-*SwiftPM support was recently added, so please report any issues you find.*
-
 Instead of parsing your source files, `jazzy` hooks into [Clang][clang] and
 [SourceKit][sourcekit] to use the [AST][ast] representation of your code and
 its comments for more accurate results. The output matches the look and feel
 of Apple’s official reference documentation, post WWDC 2014.
 
+Jazzy can also generate documentation from compiled Swift modules [using their
+symbol graph](#docs-from-swiftmodules-or-frameworks) instead of source code.
+
 ![Screenshot](images/screenshot.jpg)
 
 This project adheres to the [Contributor Covenant Code of Conduct](https://realm.io/conduct).
@@ -49,17 +50,21 @@ succeed too!
 
 If Jazzy generates docs for the wrong module then use `--module` to tell it which
 one you'd prefer.  If this doesn't help, and you're using Xcode, then try passing
-extra arguments to `xcodebuild`, for example `jazzy --build-tool-arguments -target,MyTarget`.
+extra arguments to `xcodebuild`, for example
+`jazzy --build-tool-arguments -scheme,MyScheme,-target,MyTarget`.
 
 You can set options for your project’s documentation in a configuration file,
 `.jazzy.yaml` by default. For a detailed explanation and an exhaustive list of
 all available options, run `jazzy --help config`.
 
-### Supported keywords
+### Supported documentation keywords
 
 Swift documentation is written in markdown and supports a number of special keywords.
-For a complete list and examples, see Erica Sadun's post on [*Swift header documentation in Xcode 7*](https://ericasadun.com/2015/06/14/swift-header-documentation-in-xcode-7/),
-her [book on Swift Documentation Markup](https://itunes.apple.com/us/book/swift-documentation-markup/id1049010423), and the [Xcode Markup Formatting Reference](https://developer.apple.com/library/content/documentation/Xcode/Reference/xcode_markup_formatting_ref/).
+Here are some resources with tutorials and examples, starting with the most modern:
+* Apple's [Writing Symbol Documentation in Your Source Files](https://developer.apple.com/documentation/xcode/writing-symbol-documentation-in-your-source-files) article.
+* Apple's [Formatting Your Documentation Content](https://developer.apple.com/documentation/xcode/formatting-your-documentation-content) article.
+* Apple's [Xcode Markup Formatting Reference](https://developer.apple.com/library/content/documentation/Xcode/Reference/xcode_markup_formatting_ref/).
+* Erica Sadun's [Swift header documentation in Xcode 7](https://ericasadun.com/2015/06/14/swift-header-documentation-in-xcode-7/) post and her [book on Swift Documentation Markup](https://itunes.apple.com/us/book/swift-documentation-markup/id1049010423).
 
 For Objective-C documentation the same keywords are supported, but note that the format
 is slightly different. In Swift you would write `- returns:`, but in Objective-C you write `@return`. See Apple's [*HeaderDoc User Guide*](https://developer.apple.com/legacy/library/documentation/DeveloperTools/Conceptual/HeaderDoc/tags/tags.html) for more details. **Note: `jazzy` currently does not support _all_ Objective-C keywords listed in this document, only @param, @return, @warning, @see, and @note.**
@@ -74,6 +79,12 @@ backticks generates a link, for example:
 * \`[MyClass method1]\` - a link to an Objective-C method.
 * \`-[MyClass method2:param1]\` - a link to another Objective-C method.
 
+Jazzy understands Apple's DocC-style links too, for example:
+* \`\`MyClass/method(param1:)\`\` - a link to the documentation for that method
+  that appears as just `method(param1:)` in the rendered page.
+* \`\`\<doc:method(_:)-e873\>\`\` - a link to a specific overload of `method(_:)`.
+  Jazzy can't tell which overload you intend and links to the first one.
+
 ### Math
 
 Jazzy can render math equations written in LaTeX embedded in your markdown:
@@ -106,8 +117,9 @@ jazzy \
   --clean \
   --author Realm \
   --author_url https://realm.io \
-  --github_url https://github.com/realm/realm-cocoa \
-  --github-file-prefix https://github.com/realm/realm-cocoa/tree/v0.96.2 \
+  --source-host github \
+  --source-host-url https://github.com/realm/realm-cocoa \
+  --source-host-files-url https://github.com/realm/realm-cocoa/tree/v0.96.2 \
   --module-version 0.96.2 \
   --build-tool-arguments -scheme,RealmSwift \
   --module RealmSwift \
@@ -148,8 +160,9 @@ jazzy \
   --clean \
   --author Realm \
   --author_url https://realm.io \
-  --github_url https://github.com/realm/realm-cocoa \
-  --github-file-prefix https://github.com/realm/realm-cocoa/tree/v2.2.0 \
+  --source-host github \
+  --source-host-url https://github.com/realm/realm-cocoa \
+  --source-host-files-url https://github.com/realm/realm-cocoa/tree/v2.2.0 \
   --module-version 2.2.0 \
   --build-tool-arguments --objc,Realm/Realm.h,--,-x,objective-c,-isysroot,$(xcrun --show-sdk-path),-I,$(pwd) \
   --module Realm \
@@ -165,8 +178,9 @@ jazzy \
   --objc \
   --author AFNetworking \
   --author_url http://afnetworking.com \
-  --github_url https://github.com/AFNetworking/AFNetworking \
-  --github-file-prefix https://github.com/AFNetworking/AFNetworking/tree/2.6.2 \
+  --source-host github \
+  --source-host-url https://github.com/AFNetworking/AFNetworking \
+  --source-host-files-url https://github.com/AFNetworking/AFNetworking/tree/2.6.2 \
   --module-version 2.6.2 \
   --umbrella-header AFNetworking/AFNetworking.h \
   --framework-root . \
@@ -200,6 +214,57 @@ sourcekitten doc --objc $(pwd)/MyProject/MyProject.h \
 jazzy --sourcekitten-sourcefile swiftDoc.json,objcDoc.json
 ```
 
+### Docs from `.swiftmodule`s or frameworks
+
+*This feature is new and relies on a new Swift feature: there may be crashes
+and mistakes: reports welcome.*
+
+Swift 5.3 adds support for symbol graph generation from `.swiftmodule` files.
+This looks to be part of Apple's toolchain for generating their online docs.
+
+Jazzy can use this to generate API documentation.  This is faster than using
+the source code directly but does have limitations: for example documentation
+comments are available only for `public` declarations, and the presentation of
+Swift extensions may not match the way they are written in code.
+
+Some examples:
+
+1. Generate docs for the Apple Combine framework for macOS:
+   ```shell
+   jazzy --module Combine --swift-build-tool symbolgraph
+   ```
+   The SDK's library directories are included in the search path by
+   default.
+2. Same but for iOS:
+   ```shell
+   jazzy --module Combine --swift-build-tool symbolgraph
+         --sdk iphoneos
+         --build-tool-arguments -target,arm64-apple-ios14.1
+   ```
+   The `target` is the LLVM target triple and needs to match the SDK.  The
+   default here is the target of the host system that Jazzy is running on,
+   something like `x86_64-apple-darwin19.6.0`.
+3. Generate docs for a personal `.swiftmodule`:
+   ```shell
+   jazzy --module MyMod --swift-build-tool symbolgraph
+         --build-tool-arguments -I,/Build/Products
+   ```
+   This implies that `/Build/Products/MyMod.swiftmodule` exists.  Jazzy's
+   `--source-directory` (default current directory) is searched by default,
+   so you only need the `-I` override if that's not enough.
+4. For a personal framework:
+   ```shell
+   jazzy --module MyMod --swift-build-tool symbolgraph
+         --build-tool-arguments -F,/Build/Products
+   ```
+   This implies that `/Build/Products/MyMod.framework` exists and contains
+   a `.swiftmodule`.  Again the `--source-directory` is searched by default
+   if `-F` is not passed in.
+
+See `swift symbolgraph-extract -help` for all the things you can pass via
+`--build-tool-arguments`: if your module has dependencies then you may need
+to add various search path options to let Swift load it.
+
 ### Themes
 
 Three themes are provided with jazzy: `apple` (default), `fullwidth` and `jony`.
@@ -281,6 +346,13 @@ Note that the `--include` option is applied before the `--exclude` option. For e
 Declarations with a documentation comment containing `:nodoc:` are excluded from the
 documentation.
 
+### Documentation structure
+
+By default Jazzy does not create separate web pages for declarations that do
+not have any members: instead they are nested into some parent page.  Use the
+`--separate-global-declarations` flag to change this and always create pages
+for declarations that can be directly accessed from client code.
+
 ### Choosing the Swift language version
 
 Jazzy normally uses the Swift compiler from the Xcode currently configured by