jazzy 0.13.1 → 0.13.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9f442a5c42736d08f2dcde8ca4b20745529e9c5327a47ab7ae18d49310dc115
-  data.tar.gz: 663672fbbca84610d3164ca0d9ecd69bade0f500df05b1c11f8d38366cea04ad
+  metadata.gz: b2b86b6a980392f1c5e55ebdc6a3d5be34f470c88ed12733ef10d1b10ee09078
+  data.tar.gz: 1e6e4a7d19a8eaee854a859b0ec603d239ea3ed8fb4fbd278e3c6b58673c105e
 SHA512:
-  metadata.gz: efdb407e43e83ccfdf1efbb75193101307bcc92cbf1180bd69ad849b80d14d18392e223b56691a29c11217066fb8487f1503e80b18d10458c81ce0cfca2f677c
-  data.tar.gz: 62117927494054f86f4bb3c81d3840c2fc6609095dffdc8e673dbea44a4e0c4fd7ade038e3572335e96bafdb7055061b1492509dcf3a709596ef00129c94afe7
+  metadata.gz: 0f9d68395fc4485cfbda0eb968170eeb5b624f7b5c1132e50f636cb9b74e9b6435caf69f5d66d2f1bd68220b8e0cba3dd5d526bea8d672849421ffde75627cb5
+  data.tar.gz: a288fbb15a612580d0f6f1e95325f5899cc90d76bf04c05a4e4153c6df82044c281113a14a60179d2105ba92cfeea80fecd5b27fcbeba19eb053f91db3cefbc2

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/CHANGELOG.md

@@ -1,4 +1,44 @@
-## Master
+## 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.2)
       cocoapods (~> 1.5)
       mustache (~> 1.1)
       open4
@@ -36,10 +36,10 @@ GEM
     clintegracon (0.7.0)
       colored (~> 1.2)
       diffy
-    cocoapods (1.8.4)
+    cocoapods (1.9.1)
       activesupport (>= 4.0.2, < 5)
       claide (>= 1.0.2, < 2.0)
-      cocoapods-core (= 1.8.4)
+      cocoapods-core (= 1.9.1)
       cocoapods-deintegrate (>= 1.0.3, < 2.0)
       cocoapods-downloader (>= 1.2.2, < 2.0)
       cocoapods-plugins (>= 1.0.0, < 2.0)
@@ -54,13 +54,15 @@ 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.1)
       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)
@@ -73,19 +75,19 @@ GEM
     cocoapods-try (1.1.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 (6.3.2)
       claide (~> 1.0)
       claide-plugins (>= 0.9.2)
       colored2 (~> 3.1)
       cork (~> 0.1)
       faraday (~> 0.9)
       faraday-http-cache (~> 2.0)
-      git (~> 1.5)
+      git (~> 1.6)
       kramdown (~> 2.0)
       kramdown-parser-gfm (~> 1.0)
       no_proxy_fix
@@ -93,16 +95,19 @@ GEM
       terminal-table (~> 1)
     diffy (3.3.0)
     escape (0.0.4)
+    ethon (0.12.0)
+      ffi (>= 1.3.0)
     faraday (0.17.3)
       multipart-post (>= 1.2, < 3)
     faraday-http-cache (2.0.0)
       faraday (~> 0.8)
-    ffi (1.11.3)
+    ffi (1.12.2)
     fourflusher (2.3.1)
     fuzzy_match (2.0.4)
     gh_inspector (1.1.3)
-    git (1.5.0)
-    hashdiff (1.0.0)
+    git (1.6.0)
+      rchardet (~> 1.8)
+    hashdiff (1.0.1)
     httpclient (2.8.3)
     i18n (0.9.5)
       concurrent-ruby (~> 1.0)
@@ -111,7 +116,7 @@ GEM
     kramdown-parser-gfm (1.1.0)
       kramdown (~> 2.0)
     liferaft (0.0.6)
-    minitest (5.13.0)
+    minitest (5.14.0)
     mocha (1.11.2)
     mocha-on-bacon (0.2.3)
       mocha (>= 0.13.0)
@@ -122,12 +127,12 @@ GEM
     nap (1.1.0)
     netrc (0.11.0)
     no_proxy_fix (0.1.2)
-    octokit (4.15.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.7.0.1)
+    parser (2.7.0.5)
       ast (~> 2.4.0)
     powerpack (0.1.2)
     prettybacon (0.0.2)
@@ -135,9 +140,10 @@ GEM
     public_suffix (4.0.3)
     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)
+    rouge (3.17.0)
     rubocop (0.49.0)
       parallel (~> 1.10)
       parser (>= 2.3.3.1, < 3.0)
@@ -157,16 +163,18 @@ GEM
     terminal-table (1.8.0)
       unicode-display_width (~> 1.1, >= 1.1.1)
     thread_safe (0.3.6)
+    typhoeus (1.3.1)
+      ethon (>= 0.9.0)
     tzinfo (1.2.6)
       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.14.0)
+    xcodeproj (1.15.0)
       CFPropertyList (>= 2.3.3, < 4.0)
       atomos (~> 0.1.3)
       claide (>= 1.0.2, < 2.0)
@@ -186,7 +194,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.

data/jazzy.gemspec

@@ -27,7 +27,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'xcinvoke', '~> 0.3.0'
 
   spec.add_development_dependency 'bundler', '~> 1.7'
-  spec.add_development_dependency 'rake', '~> 10.3'
+  spec.add_development_dependency 'rake', '~> 13.0'
 
   spec.required_ruby_version = '>= 2.0.0'
 end

data/lib/jazzy/config.rb

@@ -156,6 +156,11 @@ module Jazzy
                    'projects.',
       default: ''
 
+    config_attr :keep_property_attributes,
+      command_line: '--[no-]keep-property-attributes',
+      description: 'Include the default Objective-C property attributes.',
+      default: false
+
     config_attr :config_file,
       command_line: '--config PATH',
       description: ['Configuration file (.yaml or .json)',

data/lib/jazzy/doc.rb

@@ -51,5 +51,9 @@ module Jazzy
         "#{config.module_name} Docs"
       end
     end
+
+    def enable_katex
+      Markdown.has_math
+    end
   end
 end

data/lib/jazzy/doc_builder.rb

@@ -130,6 +130,7 @@ module Jazzy
       end
 
       copy_assets(output_dir)
+      copy_extensions(output_dir)
 
       DocsetBuilder.new(output_dir, source_module).build!
 
@@ -210,6 +211,15 @@ module Jazzy
       end
     end
 
+    def self.copy_extensions(destination)
+      copy_extension('katex', destination) if Markdown.has_math
+    end
+
+    def self.copy_extension(name, destination)
+      ext_directory = Pathname(__FILE__).parent + 'extensions/' + name
+      FileUtils.cp_r(ext_directory.children, destination)
+    end
+
     def self.render(doc_model, markdown)
       html = Markdown.render(markdown)
       SourceKitten.autolink_document(html, doc_model)
@@ -341,6 +351,7 @@ module Jazzy
       abstract = (item.abstract || '') + (item.discussion || '')
       {
         name:                       item.name,
+        name_html:                  item.name.gsub(':', ':<wbr>'),
         abstract:                   abstract,
         declaration:                item.display_declaration,
         language:                   item.display_language,