jazzy 0.13.0 → 0.13.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d55202d57dfdb0b3aad10b90f122d34e10a529bf73dde92ce2d0063473c011fe
-  data.tar.gz: 221dd32f5dac077431fe1d449b857966b2b9dcfc8a5f4cd0cefd61e1862558c9
+  metadata.gz: 9b896e2cc19ed17de08bbaf77655ce4cc28ba3b086c4b324c6f3c15d3f61c5c2
+  data.tar.gz: 6dda6fa99cc9c4282f3818f405f218b23d22e57b6869be208082e36b25873dd0
 SHA512:
-  metadata.gz: cf1b7616ead246ea0e45a0c1e3148fc8cf3a04600c295c5bec0c7b5cff530296b9deb50f6b9c429940c1bf12dce036d4863038e55b3f892e748e5e99e7f3fc65
-  data.tar.gz: e7725d323d9550f97f27a6bd2e0c89d674cda5d4199dc6433e38f7b78e01f58388d8af8842c28293abb9ce4434068e24fbf1483941e2ab771787db7220dd788a
+  metadata.gz: 7d3a45bc3b94976166452b9ddf2c411dff01acedd555ba7b124f5eb66c078f5cdab652958a83017e1a253384b874316bf25e523a6eb6f814eb8c04b282063ee5
+  data.tar.gz: e7816087c597af5c4811f7c1155160242268b6beb25c610d93f571e749bc2c92edc7633712eed492d882d23f9576af98637ef46e8857ed4f547608ede6387439

data/.circleci/config.yml

@@ -17,7 +17,7 @@ jobs:
 
   swift:
     macos:
-      xcode: "11.2.0"
+      xcode: "11.4.0"
     environment: *bundler-environment
     steps:
       - checkout
@@ -29,7 +29,7 @@ jobs:
 
   objc:
     macos:
-      xcode: "11.2.0"
+      xcode: "11.4.0"
     environment: *bundler-environment
     steps:
       - checkout
@@ -41,7 +41,7 @@ jobs:
 
   cocoapods:
     macos:
-      xcode: "11.2.0"
+      xcode: "11.4.0"
     environment: *bundler-environment
     steps:
       - checkout

data/.gitignore

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

data/CHANGELOG.md

@@ -1,3 +1,156 @@
+## 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
+
+* None.
+
+##### Enhancements
+
+* Allow inline html tags in ObjC doc comments.  
+  [Chris Williams](https://github.com/ultramiraculous)
+  [#976](https://github.com/realm/jazzy/issues/976)
+
+* Support code formatting in ObjC doc comments with `@c`, `@code` and
+  `@endcode`.  
+  [Bryce Pauken](https://github.com/brycepauken)
+  [jpsim/SourceKitten#631](https://github.com/jpsim/SourceKitten/issues/631)
+
+* Add `custom_categories_unlisted_prefix` configuration setting. This
+  is the prefix for navigation section names that aren't explicitly
+  listed in `custom_categories`. Defaults to 'Other '.  
+  [JP Simard](https://github.com/jpsim)
+
+* Add `hide_unlisted_documentation` configuration setting. Setting this
+  to `true` hides documentation entries in the sidebar from the
+  `documentation` config value that aren't explicitly listed in
+  `custom_categories`.  
+  [JP Simard](https://github.com/jpsim)
+
+##### Bug Fixes
+
+* Fix crash when SourceKit returns out of bounds string byte offsets.  
+  [JP Simard](https://github.com/jpsim)
+
+* Pick the right version of declarations with type attributes.  
+  [John Fairhurst](https://github.com/johnfairh)
+  [#1148](https://github.com/realm/jazzy/issues/1148)
+
 ## 0.13.0
 
 ##### 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.0)
+    jazzy (0.13.5)
       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)
+    activesupport (4.2.11.3)
       i18n (~> 0.7)
       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.3)
       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,10 +36,10 @@ GEM
     clintegracon (0.7.0)
       colored (~> 1.2)
       diffy
-    cocoapods (1.8.4)
+    cocoapods (1.9.3)
       activesupport (>= 4.0.2, < 5)
       claide (>= 1.0.2, < 2.0)
-      cocoapods-core (= 1.8.4)
+      cocoapods-core (= 1.9.3)
       cocoapods-deintegrate (>= 1.0.3, < 2.0)
       cocoapods-downloader (>= 1.2.2, < 2.0)
       cocoapods-plugins (>= 1.0.0, < 2.0)
@@ -54,38 +54,40 @@ GEM
       molinillo (~> 0.6.6)
       nap (~> 1.0)
       ruby-macho (~> 1.4)
-      xcodeproj (>= 1.11.1, < 2.0)
-    cocoapods-core (1.8.4)
+      xcodeproj (>= 1.14.0, < 2.0)
+    cocoapods-core (1.9.3)
       activesupport (>= 4.0.2, < 6)
       algoliasearch (~> 1.0)
       concurrent-ruby (~> 1.1)
       fuzzy_match (~> 2.0.4)
       nap (~> 1.0)
+      netrc (~> 0.11)
+      typhoeus (~> 1.0)
     cocoapods-deintegrate (1.0.4)
     cocoapods-downloader (1.3.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.6)
     cork (0.3.0)
       colored2 (~> 3.1)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
-    danger (6.1.0)
+    danger (8.0.2)
       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)
+      git (~> 1.7)
       kramdown (~> 2.0)
       kramdown-parser-gfm (~> 1.0)
       no_proxy_fix
@@ -93,26 +95,30 @@ GEM
       terminal-table (~> 1)
     diffy (3.3.0)
     escape (0.0.4)
-    faraday (0.17.1)
+    ethon (0.12.0)
+      ffi (>= 1.3.0)
+    faraday (1.0.1)
       multipart-post (>= 1.2, < 3)
-    faraday-http-cache (2.0.0)
-      faraday (~> 0.8)
-    ffi (1.11.3)
+    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)
       concurrent-ruby (~> 1.0)
-    json (2.2.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)
-    mocha (1.10.1)
+    minitest (5.14.1)
+    mocha (1.11.2)
     mocha-on-bacon (0.2.3)
       mocha (>= 0.13.0)
     molinillo (0.6.6)
@@ -122,21 +128,24 @@ GEM
     nap (1.1.0)
     netrc (0.11.0)
     no_proxy_fix (0.1.2)
-    octokit (4.14.0)
+    octokit (4.18.0)
+      faraday (>= 0.9)
       sawyer (~> 0.8.0, >= 0.5.3)
     open4 (1.3.4)
-    parallel (1.19.1)
-    parser (2.6.5.0)
-      ast (~> 2.4.0)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
     powerpack (0.1.2)
     prettybacon (0.0.2)
       bacon (~> 1.2)
-    public_suffix (4.0.1)
+    public_suffix (4.0.5)
     rainbow (2.2.2)
       rake
-    rake (10.5.0)
+    rake (13.0.1)
+    rchardet (1.8.0)
     redcarpet (3.5.0)
-    rouge (3.13.0)
+    rexml (3.2.4)
+    rouge (3.20.0)
     rubocop (0.49.0)
       parallel (~> 1.10)
       parser (>= 2.3.3.1, < 3.0)
@@ -147,25 +156,27 @@ GEM
     ruby-macho (1.4.0)
     ruby-progressbar (1.10.1)
     safe_yaml (1.0.5)
-    sassc (2.2.1)
+    sassc (2.4.0)
       ffi (~> 1.9)
     sawyer (0.8.2)
       addressable (>= 2.3.5)
       faraday (> 0.8, < 2.0)
-    sqlite3 (1.4.1)
+    sqlite3 (1.4.2)
     terminal-table (1.8.0)
       unicode-display_width (~> 1.1, >= 1.1.1)
     thread_safe (0.3.6)
-    tzinfo (1.2.5)
+    typhoeus (1.4.0)
+      ethon (>= 0.9.0)
+    tzinfo (1.2.7)
       thread_safe (~> 0.1)
-    unicode-display_width (1.6.0)
-    webmock (3.7.6)
+    unicode-display_width (1.7.0)
+    webmock (3.8.3)
       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.13.0)
+    xcodeproj (1.17.0)
       CFPropertyList (>= 2.3.3, < 4.0)
       atomos (~> 0.1.3)
       claide (>= 1.0.2, < 2.0)
@@ -185,7 +196,7 @@ DEPENDENCIES
   mocha
   mocha-on-bacon
   prettybacon
-  rake (~> 10.3)
+  rake (~> 13.0)
   rubocop (= 0.49.0)
   webmock
 

data/README.md

@@ -47,6 +47,10 @@ 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 -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`.
@@ -70,6 +74,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.
@@ -258,6 +281,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