jazzy 0.13.1 → 0.13.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9f442a5c42736d08f2dcde8ca4b20745529e9c5327a47ab7ae18d49310dc115
-  data.tar.gz: 663672fbbca84610d3164ca0d9ecd69bade0f500df05b1c11f8d38366cea04ad
+  metadata.gz: 20ab471420ed44e905319be51f0410c0571efa3f56902834b6e7d47f4f66fd0a
+  data.tar.gz: 2bfa14b53c563edb51d4cf0f0a4041859929561b725324761f17568410819838
 SHA512:
-  metadata.gz: efdb407e43e83ccfdf1efbb75193101307bcc92cbf1180bd69ad849b80d14d18392e223b56691a29c11217066fb8487f1503e80b18d10458c81ce0cfca2f677c
-  data.tar.gz: 62117927494054f86f4bb3c81d3840c2fc6609095dffdc8e673dbea44a4e0c4fd7ade038e3572335e96bafdb7055061b1492509dcf3a709596ef00129c94afe7
+  metadata.gz: 6c5b2eeb4b88f7cf4c8b406bc627c754b50f7f95cd9c555127998530e201b7dfc0e86c237cff3f3dff71c85fa6c979733e0b75de6fd4c52333de8e9d9cf741b0
+  data.tar.gz: 672470f7c618f5fc659035a2705674b3804558abc86d58c788943f1495e7e4e3de9447ae6ee46156b68c11776d32986551c91a7f7b222fda455e59f89bc91973

data/.circleci/config.yml

@@ -17,11 +17,12 @@ jobs:
 
   swift:
     macos:
-      xcode: "11.2.0"
+      xcode: "12.1.0"
     environment: *bundler-environment
     steps:
       - checkout
       - restore_cache: *restore-mac-bundler-cache
+      - run: echo 'chruby 2.6' >> ~/.bash_profile
       - run: bundle install
       - run: git submodule update --init --recursive
       - run: bundle exec rake swift_spec
@@ -29,11 +30,12 @@ jobs:
 
   objc:
     macos:
-      xcode: "11.2.0"
+      xcode: "12.1.0"
     environment: *bundler-environment
     steps:
       - checkout
       - restore_cache: *restore-mac-bundler-cache
+      - run: echo 'chruby 2.6' >> ~/.bash_profile
       - run: bundle install
       - run: git submodule update --init --recursive
       - run: bundle exec rake objc_spec
@@ -41,13 +43,14 @@ jobs:
 
   cocoapods:
     macos:
-      xcode: "11.2.0"
+      xcode: "12.1.0"
     environment: *bundler-environment
     steps:
       - checkout
       - restore_cache:
           key: cocoapods
       - restore_cache: *restore-mac-bundler-cache
+      - run: echo 'chruby 2.6' >> ~/.bash_profile
       - run: bundle install
       - run: git submodule update --init --recursive
       - run: bundle exec rake cocoapods_spec

data/.gitignore

@@ -1,5 +1,6 @@
 jazzy-docs/
 /docs/
+node_modules
 
 *.gem
 *.rbc

data/CHANGELOG.md

@@ -1,4 +1,138 @@
-## Master
+## 0.13.6
+
+##### Breaking
+
+* None.
+
+##### Enhancements
+
+* Support documentation generation from `.swiftmodule` binaries using
+  `--swift-build-tool symbolgraph` with Swift 5.3.  
+  [John Fairhurst](https://github.com/johnfairh)
+
+##### Bug Fixes
+
+* Always bypass codesigning when building Xcode projects.  
+  [John Fairhurst](https://github.com/johnfairh)
+  [#1183](https://github.com/realm/jazzy/issues/1183)
+
+## 0.13.5
+
+##### Breaking
+
+* None.
+
+##### Enhancements
+
+* Add search function to `apple` theme.  
+  [Giles Payne](https://github.com/komakai)
+  [#726](https://github.com/realm/jazzy/issues/726)
+
+* Add option `--[no-]separate-global-declarations` to always create separate
+  documentation pages for top-level declarations as well as classes,
+  structures, enums etc. even if they don't have members. As part of this,
+  improve the main page declaration in all modes.  
+  [Nikolay Volosatov](https://github.com/bamx23)
+  [John Fairhurst](https://github.com/johnfairh)
+
+##### Bug Fixes
+
+* Style fixes for `apple` and `jony` themes to codeblocks inside lists and
+  links.  
+  [John Fairhurst](https://github.com/johnfairh)
+  [#818](https://github.com/realm/jazzy/issues/818)
+  [#1177](https://github.com/realm/jazzy/issues/1177)
+
+## 0.13.4
+
+##### Breaking
+
+* None.
+
+##### Enhancements
+
+* Update JavaScript libraries: jQuery 3.5.1 (all themes), Lunr 2.3.8,
+  typeahead.js 1.3.1 (`fullwidth` theme only).  
+  [John Fairhurst](https://github.com/johnfairh)
+
+##### Bug Fixes
+
+* Fix warnings from Ruby 2.7.  
+  [John Fairhurst](https://github.com/johnfairh)
+  [#1185](https://github.com/realm/jazzy/issues/1185)
+
+* Accept `root_url` without trailing slash.  
+  [John Fairhurst](https://github.com/johnfairh)
+  [#1188](https://github.com/realm/jazzy/issues/1188)
+
+## 0.13.3
+
+##### Breaking
+
+* None.
+
+##### Enhancements
+
+* Added a config option to provide sources of privately hosted pod
+  dependencies when using the `--podspec` option.
+  `--pod-sources url1,url2,…urlN`.  
+  [Jonathan Bailey](https://github.com/jon889)
+  [#650](https://github.com/realm/jazzy/issues/650)
+
+* Improve Dash docset support: support online redirection when
+  `--root-url` is set, and provide `--docset-playground-url` to
+  support docset playground links.  
+  [John Fairhurst](https://github.com/johnfairh)
+
+##### Bug Fixes
+
+* Fix module version not being used from podspec.  
+  [Jonathan Bailey](https://github.com/jon889)
+
+* Autolink Swift custom attributes/property wrappers.  
+  [John Fairhurst](https://github.com/johnfairh)
+
+## 0.13.2
+
+##### Breaking
+
+* None.
+
+##### Enhancements
+
+* Support Xcode 11.4.  Default Objective-C property attributes are now
+  stripped from declarations: turn this off with
+  `--keep-default-property-attributes`.  
+  [John Fairhurst](https://github.com/johnfairh)
+  [#829](https://github.com/realm/jazzy/issues/829)
+
+* Render LaTeX expressions written using `$equation$` or `$$equation$$`
+  syntax.  
+  [Arthur Guiot](https://github.com/arguiot)
+  [John Fairhurst](https://github.com/johnfairh)
+  [#1156](https://github.com/realm/jazzy/issues/1156)
+
+* Wrap long method names on category pages.  Use `name_html` in custom
+  mustache templates to take advantage of this.  
+  [John Fairhurst](https://github.com/johnfairh)
+  [#995](https://github.com/realm/jazzy/issues/995)
+
+* Support Dash-style `apple_ref` links to specific API items, for more
+  stable and human-readable links from external docs.  
+  [Paul Cantrell](https://github.com/pcantrell)
+
+##### Bug Fixes
+
+* Don't generate documentation if the `xcodebuild` command fails.  
+  [John Fairhurst](https://github.com/johnfairh)
+  [jpsim/SourceKitten#643](https://github.com/jpsim/SourceKitten/issues/643)
+
+* Use multi-line parsed declarations in more places including protocol
+  methods and typealiases.  
+  [John Fairhurst](https://github.com/johnfairh)
+  [#896](https://github.com/realm/jazzy/issues/896)
+
+## 0.13.1
 
 ##### Breaking
 

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 11.2 installed to build the integration specs.
+You must have Xcode 11.4 installed to build the integration specs.
 
 ## Making changes to SourceKitten
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    jazzy (0.13.1)
+    jazzy (0.13.6)
       cocoapods (~> 1.5)
       mustache (~> 1.1)
       open4
@@ -15,17 +15,17 @@ GEM
   remote: https://rubygems.org/
   specs:
     CFPropertyList (3.0.2)
-    activesupport (4.2.11.1)
-      i18n (~> 0.7)
+    activesupport (5.2.4.4)
+      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)
       public_suffix (>= 2.0.2, < 5.0)
-    algoliasearch (1.27.1)
+    algoliasearch (1.27.5)
       httpclient (~> 2.8, >= 2.8.3)
       json (>= 1.5.1)
-    ast (2.4.0)
+    ast (2.4.1)
     atomos (0.1.3)
     bacon (1.2.0)
     claide (1.0.3)
@@ -36,15 +36,14 @@ GEM
     clintegracon (0.7.0)
       colored (~> 1.2)
       diffy
-    cocoapods (1.8.4)
-      activesupport (>= 4.0.2, < 5)
+    cocoapods (1.10.0)
+      addressable (~> 2.6)
       claide (>= 1.0.2, < 2.0)
-      cocoapods-core (= 1.8.4)
+      cocoapods-core (= 1.10.0)
       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,90 +53,99 @@ GEM
       molinillo (~> 0.6.6)
       nap (~> 1.0)
       ruby-macho (~> 1.4)
-      xcodeproj (>= 1.11.1, < 2.0)
-    cocoapods-core (1.8.4)
-      activesupport (>= 4.0.2, < 6)
+      xcodeproj (>= 1.19.0, < 2.0)
+    cocoapods-core (1.10.0)
+      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-trunk (1.4.1)
+    cocoapods-trunk (1.5.0)
       nap (>= 0.8, < 2.0)
       netrc (~> 0.11)
-    cocoapods-try (1.1.0)
+    cocoapods-try (1.2.0)
     colored (1.2)
     colored2 (3.1.2)
-    concurrent-ruby (1.1.5)
+    concurrent-ruby (1.1.7)
     cork (0.3.0)
       colored2 (~> 3.1)
-    crack (0.4.3)
-      safe_yaml (~> 1.0.0)
-    danger (6.1.0)
+    crack (0.4.4)
+    danger (8.2.0)
       claide (~> 1.0)
       claide-plugins (>= 0.9.2)
       colored2 (~> 3.1)
       cork (~> 0.1)
-      faraday (~> 0.9)
+      faraday (>= 0.9.0, < 2.0)
       faraday-http-cache (~> 2.0)
-      git (~> 1.5)
-      kramdown (~> 2.0)
+      git (~> 1.7)
+      kramdown (~> 2.3)
       kramdown-parser-gfm (~> 1.0)
       no_proxy_fix
       octokit (~> 4.7)
       terminal-table (~> 1)
-    diffy (3.3.0)
+    diffy (3.4.0)
     escape (0.0.4)
-    faraday (0.17.3)
+    ethon (0.12.0)
+      ffi (>= 1.3.0)
+    faraday (1.1.0)
       multipart-post (>= 1.2, < 3)
-    faraday-http-cache (2.0.0)
-      faraday (~> 0.8)
-    ffi (1.11.3)
+      ruby2_keywords
+    faraday-http-cache (2.2.0)
+      faraday (>= 0.8)
+    ffi (1.13.1)
     fourflusher (2.3.1)
     fuzzy_match (2.0.4)
     gh_inspector (1.1.3)
-    git (1.5.0)
-    hashdiff (1.0.0)
+    git (1.7.0)
+      rchardet (~> 1.8)
+    hashdiff (1.0.1)
     httpclient (2.8.3)
-    i18n (0.9.5)
+    i18n (1.8.5)
       concurrent-ruby (~> 1.0)
-    json (2.3.0)
-    kramdown (2.1.0)
+    json (2.3.1)
+    kramdown (2.3.0)
+      rexml
     kramdown-parser-gfm (1.1.0)
       kramdown (~> 2.0)
     liferaft (0.0.6)
-    minitest (5.13.0)
+    minitest (5.14.2)
     mocha (1.11.2)
     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.15.0)
+    octokit (4.19.0)
       faraday (>= 0.9)
       sawyer (~> 0.8.0, >= 0.5.3)
     open4 (1.3.4)
-    parallel (1.19.1)
-    parser (2.7.0.1)
-      ast (~> 2.4.0)
+    parallel (1.20.0)
+    parser (2.7.2.0)
+      ast (~> 2.4.1)
     powerpack (0.1.2)
     prettybacon (0.0.2)
       bacon (~> 1.2)
-    public_suffix (4.0.3)
+    public_suffix (4.0.6)
     rainbow (2.2.2)
       rake
-    rake (10.5.0)
+    rake (13.0.1)
+    rchardet (1.8.0)
     redcarpet (3.5.0)
-    rouge (3.14.0)
+    rexml (3.2.4)
+    rouge (3.24.0)
     rubocop (0.49.0)
       parallel (~> 1.10)
       parser (>= 2.3.3.1, < 3.0)
@@ -147,8 +155,8 @@ GEM
       unicode-display_width (~> 1.0, >= 1.0.1)
     ruby-macho (1.4.0)
     ruby-progressbar (1.10.1)
-    safe_yaml (1.0.5)
-    sassc (2.2.1)
+    ruby2_keywords (0.0.2)
+    sassc (2.4.0)
       ffi (~> 1.9)
     sawyer (0.8.2)
       addressable (>= 2.3.5)
@@ -157,21 +165,23 @@ GEM
     terminal-table (1.8.0)
       unicode-display_width (~> 1.1, >= 1.1.1)
     thread_safe (0.3.6)
-    tzinfo (1.2.6)
+    typhoeus (1.4.0)
+      ethon (>= 0.9.0)
+    tzinfo (1.2.8)
       thread_safe (~> 0.1)
-    unicode-display_width (1.6.0)
-    webmock (3.7.6)
+    unicode-display_width (1.7.0)
+    webmock (3.9.4)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
     xcinvoke (0.3.0)
       liferaft (~> 0.0.6)
-    xcodeproj (1.14.0)
+    xcodeproj (1.19.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)
 
 PLATFORMS
   ruby
@@ -186,7 +196,7 @@ DEPENDENCIES
   mocha
   mocha-on-bacon
   prettybacon
-  rake (~> 10.3)
+  rake (~> 13.0)
   rubocop (= 0.49.0)
   webmock
 

data/README.md

@@ -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).
@@ -47,11 +48,16 @@ If your Swift module is the first thing to build, and it builds fine when runnin
 just running `jazzy` (without any arguments) from the root of your project should
 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 -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/),
@@ -70,6 +76,25 @@ 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.
 
+### Math
+
+Jazzy can render math equations written in LaTeX embedded in your markdown:
+* `` `$equation$` `` renders the equation in an inline style.
+* `` `$$equation$$` `` renders the equation in a display style, centered on a
+  line of its own.
+
+For example, the markdown:
+```markdown
+Inline: `$ax^2+bx+c=0$`
+
+Block: `$$x={\frac {-b\pm {\sqrt {b^{2}-4ac}}}{2a}}$$`
+```
+..renders as:
+
+![math](images/math.png)
+
+Math support is provided by [KaTeX](https://katex.org).
+
 ### Swift
 
 Swift documentation is generated by default.
@@ -177,6 +202,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`.
@@ -258,6 +334,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