jazzy 0.9.6 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7723d71fdd04817497ff84b517c5d413b43857f56167f3fc96a6de3e082e9cf3
-  data.tar.gz: e9c0a9283b79b76ecaece6ed35d3d323ffafb370d228f4fcc3e00c81876a6fac
+  metadata.gz: bc3616cb1da2da7c201cea6c6bc81659ee5a816da770bc8cc5c087b75e227a19
+  data.tar.gz: 9a459463afd8a9b12881175acb5c638d1c27d4f86f6a78898d4d04fd77a2912f
 SHA512:
-  metadata.gz: d3d6685a6ca5b1eea07b0775bd0368f4f259e0325fb68f08a24d9ac1d8855b9759feeaad387d34fbd7201cfb61c031f31723fbe3fa65a236fffb01ac422fbb99
-  data.tar.gz: cc8b9d21b5876440a0a2858791a5e516f550d805b22b41def851921814ff96748880bfab5d613f22297d7570fdb6bd82462eac3597defff8f4464a6b93835164
+  metadata.gz: d7e283f41d40a59988031091c64b1be2fc8a78334a3e544d4e00cfe2cb08beebffd2c2148e2e82cd8db63125c88a7ea8d1262e16c8fca1440ee8ef5f64cfbc89
+  data.tar.gz: fa1111eda7b0f9f4d06ee49ddd1f114d0625970f77f3ef6515ddac933ce4551eed8852db56e89b95fa80f82e28b75508ecaf90e303df994659a169ae732cf9c7

data/CHANGELOG.md

@@ -1,3 +1,47 @@
+## 0.10.0
+
+##### Breaking
+
+* The included `sourcekitten` binary is built with Xcode 10.2.  This means
+  it does not run on macOS earlier than 10.14.4 without the *Swift 5 Runtime
+  Support for Command Line Tools* being installed.  
+  [John Fairhurst](https://github.com/johnfairh)
+
+##### Enhancements
+
+* Support CocoaPods 1.6+.  Use the `swift_version[s]` dsl in `--podspec` mode
+  to set the Swift language version.  
+  [John Fairhurst](https://github.com/johnfairh)
+
+* Show the extension declaration when documenting Swift extensions.  
+  [John Fairhurst](https://github.com/johnfairh)
+
+* Allow docs title customization.  Include `--module-version` when it is set
+  and support `--title` to fully customize the title.  Pass `{{module_version}}`
+  and `{{docs_title}}` to templates.  
+  [Maximilian Alexander](https://github.com/mbalex99)
+  [John Fairhurst](https://github.com/johnfairh)
+  [#666](https://github.com/realm/jazzy/issues/666)
+  [#411](https://github.com/realm/jazzy/issues/411)
+
+##### Bug Fixes
+
+* Unfold member documentation when linked to from current web page.  
+  [John Fairhurst](https://github.com/johnfairh)
+  [#788](https://github.com/realm/jazzy/issues/788)
+
+* Generate docs when there are unusual characters in source pathnames.  
+  [John Fairhurst](https://github.com/johnfairh)
+  [#1049](https://github.com/realm/jazzy/issues/1049)
+
+* Generate docs for signed modules with Xcode 10.2.  
+  [John Fairhurst](https://github.com/johnfairh)
+  [#1057](https://github.com/realm/jazzy/issues/1057)
+
+* Use correct module name when only target name is supplied.  
+  [Chris Zielinski](https://github.com/chriszielinski)
+  [#422](https://github.com/realm/jazzy/issues/422)
+
 ## 0.9.6
 
 This is (probably) the last release to support Ruby earlier than 2.3.

data/Gemfile.lock

@@ -1,14 +1,14 @@
 PATH
   remote: .
   specs:
-    jazzy (0.9.6)
-      cocoapods (~> 1.5.3)
-      mustache (~> 1.1.0)
+    jazzy (0.10.0)
+      cocoapods (~> 1.5)
+      mustache (~> 1.1)
       open4
-      redcarpet (~> 3.4.0)
+      redcarpet (~> 3.4)
       rouge (>= 2.0.6, < 4.0)
-      sass (~> 3.6.0)
-      sqlite3 (~> 1.3.13)
+      sass (~> 3.6)
+      sqlite3 (~> 1.3)
       xcinvoke (~> 0.3.0)
 
 GEM
@@ -20,7 +20,7 @@ GEM
       minitest (~> 5.1)
       thread_safe (~> 0.3, >= 0.3.4)
       tzinfo (~> 1.1)
-    addressable (2.5.2)
+    addressable (2.6.0)
       public_suffix (>= 2.0.2, < 4.0)
     ast (2.4.0)
     atomos (0.1.3)
@@ -33,26 +33,26 @@ GEM
     clintegracon (0.7.0)
       colored (~> 1.2)
       diffy
-    cocoapods (1.5.3)
+    cocoapods (1.7.2)
       activesupport (>= 4.0.2, < 5)
       claide (>= 1.0.2, < 2.0)
-      cocoapods-core (= 1.5.3)
-      cocoapods-deintegrate (>= 1.0.2, < 2.0)
-      cocoapods-downloader (>= 1.2.0, < 2.0)
+      cocoapods-core (= 1.7.2)
+      cocoapods-deintegrate (>= 1.0.3, < 2.0)
+      cocoapods-downloader (>= 1.2.2, < 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.3.0, < 2.0)
+      cocoapods-trunk (>= 1.3.1, < 2.0)
       cocoapods-try (>= 1.1.0, < 2.0)
       colored2 (~> 3.1)
       escape (~> 0.0.4)
-      fourflusher (~> 2.0.1)
+      fourflusher (>= 2.3.0, < 3.0)
       gh_inspector (~> 1.0)
-      molinillo (~> 0.6.5)
+      molinillo (~> 0.6.6)
       nap (~> 1.0)
-      ruby-macho (~> 1.1)
-      xcodeproj (>= 1.5.7, < 2.0)
-    cocoapods-core (1.5.3)
+      ruby-macho (~> 1.4)
+      xcodeproj (>= 1.10.0, < 2.0)
+    cocoapods-core (1.7.2)
       activesupport (>= 4.0.2, < 6)
       fuzzy_match (~> 2.0.4)
       nap (~> 1.0)
@@ -73,13 +73,13 @@ GEM
       colored2 (~> 3.1)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
-    danger (6.0.2)
+    danger (6.0.9)
       claide (~> 1.0)
       claide-plugins (>= 0.9.2)
       colored2 (~> 3.1)
       cork (~> 0.1)
       faraday (~> 0.9)
-      faraday-http-cache (~> 1.0)
+      faraday-http-cache (~> 2.0)
       git (~> 1.5)
       kramdown (~> 2.0)
       kramdown-parser-gfm (~> 1.0)
@@ -90,28 +90,28 @@ GEM
     escape (0.0.4)
     faraday (0.15.4)
       multipart-post (>= 1.2, < 3)
-    faraday-http-cache (1.3.1)
+    faraday-http-cache (2.0.0)
       faraday (~> 0.8)
-    ffi (1.10.0)
-    fourflusher (2.0.1)
+    ffi (1.11.1)
+    fourflusher (2.3.1)
     fuzzy_match (2.0.4)
     gh_inspector (1.1.3)
     git (1.5.0)
-    hashdiff (0.3.8)
+    hashdiff (0.4.0)
     i18n (0.9.5)
       concurrent-ruby (~> 1.0)
     kramdown (2.1.0)
-    kramdown-parser-gfm (1.0.1)
+    kramdown-parser-gfm (1.1.0)
       kramdown (~> 2.0)
     liferaft (0.0.6)
     metaclass (0.0.4)
     minitest (5.11.3)
-    mocha (1.8.0)
+    mocha (1.9.0)
       metaclass (~> 0.0.1)
     mocha-on-bacon (0.2.3)
       mocha (>= 0.13.0)
     molinillo (0.6.6)
-    multipart-post (2.0.0)
+    multipart-post (2.1.1)
     mustache (1.1.0)
     nanaimo (0.2.6)
     nap (1.1.0)
@@ -121,12 +121,12 @@ GEM
       sawyer (~> 0.8.0, >= 0.5.3)
     open4 (1.3.4)
     parallel (1.17.0)
-    parser (2.6.2.0)
+    parser (2.6.3.0)
       ast (~> 2.4.0)
     powerpack (0.1.2)
     prettybacon (0.0.2)
       bacon (~> 1.2)
-    public_suffix (3.0.3)
+    public_suffix (3.1.0)
     rainbow (2.2.2)
       rake
     rake (10.5.0)
@@ -134,7 +134,7 @@ GEM
     rb-inotify (0.10.0)
       ffi (~> 1.0)
     redcarpet (3.4.0)
-    rouge (3.3.0)
+    rouge (3.4.1)
     rubocop (0.49.0)
       parallel (~> 1.10)
       parser (>= 2.3.3.1, < 3.0)
@@ -143,30 +143,30 @@ GEM
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.0, >= 1.0.1)
     ruby-macho (1.4.0)
-    ruby-progressbar (1.10.0)
+    ruby-progressbar (1.10.1)
     safe_yaml (1.0.5)
-    sass (3.6.0)
+    sass (3.7.4)
       sass-listen (~> 4.0.0)
     sass-listen (4.0.0)
       rb-fsevent (~> 0.9, >= 0.9.4)
       rb-inotify (~> 0.9, >= 0.9.7)
-    sawyer (0.8.1)
-      addressable (>= 2.3.5, < 2.6)
-      faraday (~> 0.8, < 1.0)
-    sqlite3 (1.3.13)
+    sawyer (0.8.2)
+      addressable (>= 2.3.5)
+      faraday (> 0.8, < 2.0)
+    sqlite3 (1.4.1)
     terminal-table (1.8.0)
       unicode-display_width (~> 1.1, >= 1.1.1)
     thread_safe (0.3.6)
     tzinfo (1.2.5)
       thread_safe (~> 0.1)
-    unicode-display_width (1.5.0)
-    webmock (3.5.1)
+    unicode-display_width (1.6.0)
+    webmock (3.6.0)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
-      hashdiff
+      hashdiff (>= 0.4.0, < 2.0.0)
     xcinvoke (0.3.0)
       liferaft (~> 0.0.6)
-    xcodeproj (1.8.2)
+    xcodeproj (1.10.0)
       CFPropertyList (>= 2.3.3, < 4.0)
       atomos (~> 0.1.3)
       claide (>= 1.0.2, < 2.0)

data/README.md

@@ -235,7 +235,7 @@ jazzy --swift-version 4.1.2
 
 ## Troubleshooting
 
-#### Swift
+### Swift
 
 **Only extensions are listed in the documentation?**
 
@@ -253,7 +253,7 @@ Check the `--min-acl` setting -- see [above](#controlling-what-is-documented).
    environment variable to point to the Xcode you want before running Jazzy
    without the `--swift-version` flag.
 
-#### Installation Problems
+### Installation Problems
 
 **Can't find header files / clang**
 
@@ -268,6 +268,14 @@ The path of your active Xcode installation must not contain spaces.  So
 but `/Applications/Xcode 10.2.app/` is not.  This restriction applies only
 when *installing* Jazzy, not running it.
 
+### MacOS Before 10.14.4
+
+Starting with Jazzy 0.10.0, if you see an error similar to `dyld: Symbol not found: _$s11SubSequenceSlTl` then you need to install the [Swift 5 Runtime Support for Command Line Tools](https://support.apple.com/kb/DL1998).
+
+Alternatively, you can:
+* Update to macOS 10.14.4 or later; or
+* Install Xcode 10.2 or later at `/Applications/Xcode.app`.
+
 ## Development
 
 Please review jazzy's [contributing guidelines](https://github.com/realm/jazzy/blob/master/CONTRIBUTING.md) when submitting pull requests.

data/Rakefile

@@ -104,7 +104,7 @@ begin
   task :sourcekitten do
     sk_dir = 'SourceKitten'
     Dir.chdir(sk_dir) do
-      `swift build -c release -Xswiftc -static-stdlib`
+      `swift build -c release`
     end
     FileUtils.cp_r "#{sk_dir}/.build/release/sourcekitten", 'bin'
   end

data/jazzy.gemspec

@@ -17,13 +17,13 @@ Gem::Specification.new do |spec|
   spec.files         = `git ls-files`.split($/)
   spec.executables   << 'jazzy'
 
-  spec.add_runtime_dependency 'cocoapods', '~> 1.5.3'
-  spec.add_runtime_dependency 'mustache', '~> 1.1.0'
+  spec.add_runtime_dependency 'cocoapods', '~> 1.5'
+  spec.add_runtime_dependency 'mustache', '~> 1.1'
   spec.add_runtime_dependency 'open4'
-  spec.add_runtime_dependency 'redcarpet', '~> 3.4.0'
+  spec.add_runtime_dependency 'redcarpet', '~> 3.4'
   spec.add_runtime_dependency 'rouge', ['>= 2.0.6', '< 4.0']
-  spec.add_runtime_dependency 'sass', '~> 3.6.0'
-  spec.add_runtime_dependency 'sqlite3', '~> 1.3.13'
+  spec.add_runtime_dependency 'sass', '~> 3.6'
+  spec.add_runtime_dependency 'sqlite3', '~> 1.3'
   spec.add_runtime_dependency 'xcinvoke', '~> 0.3.0'
 
   spec.add_development_dependency 'bundler', '~> 1.7'

data/lib/jazzy/config.rb

@@ -2,7 +2,6 @@ require 'optparse'
 require 'pathname'
 require 'uri'
 
-require 'jazzy/doc'
 require 'jazzy/podspec_documenter'
 require 'jazzy/source_declaration/access_control_level'
 
@@ -213,9 +212,16 @@ module Jazzy
 
     config_attr :version,
       command_line: '--module-version VERSION',
-      description: 'module version. will be used when generating docset',
+      description: 'Version string to use as part of the the default docs '\
+                   'title and inside the docset.',
       default: '1.0'
 
+    config_attr :title,
+      command_line: '--title TITLE',
+      description: 'Title to display at the top of each page, overriding the '\
+                   'default generated from module name and version.',
+      default: ''
+
     config_attr :copyright,
       command_line: '--copyright COPYRIGHT_MARKDOWN',
       description: 'copyright markdown rendered at the bottom of the docs pages'

data/lib/jazzy/doc.rb

@@ -8,10 +8,11 @@ require 'jazzy/jazzy_markdown'
 
 module Jazzy
   class Doc < Mustache
+    include Config::Mixin
+
     self.template_name = 'doc'
 
     def copyright
-      config = Config.instance
       copyright = config.copyright || (
         # Fake date is used to keep integration tests consistent
         date = ENV['JAZZY_FAKE_DATE'] || DateTime.now.strftime('%Y-%m-%d')
@@ -28,7 +29,7 @@ module Jazzy
     end
 
     def objc_first?
-      Config.instance.objc_mode && Config.instance.hide_declarations != 'objc'
+      config.objc_mode && config.hide_declarations != 'objc'
     end
 
     def language
@@ -38,5 +39,21 @@ module Jazzy
     def language_stub
       objc_first? ? 'objc' : 'swift'
     end
+
+    def module_version
+      config.version_configured ? config.version : nil
+    end
+
+    def docs_title
+      if config.title_configured
+        config.title
+      elsif config.version_configured
+        # Fake version for integration tests
+        version = ENV['JAZZY_FAKE_MODULE_VERSION'] || config.version
+        "#{config.module_name} #{version} Docs"
+      else
+        "#{config.module_name} Docs"
+      end
+    end
   end
 end

data/lib/jazzy/gem_version.rb

@@ -1,3 +1,3 @@
 module Jazzy
-  VERSION = '0.9.6'.freeze unless defined? Jazzy::VERSION
+  VERSION = '0.10.0'.freeze unless defined? Jazzy::VERSION
 end

data/lib/jazzy/podspec_documenter.rb

@@ -18,7 +18,8 @@ module Jazzy
       Pod::Config.instance.with_changes(installation_root: installation_root,
                                         verbose: false) do
         sandbox = Pod::Sandbox.new(Pod::Config.instance.sandbox_root)
-        installer = Pod::Installer.new(sandbox, podfile)
+        swift_version = compiler_swift_version(config.swift_version)
+        installer = Pod::Installer.new(sandbox, podfile(swift_version))
         installer.install!
         stdout = Dir.chdir(sandbox.root) do
           targets = installer.pod_targets
@@ -27,8 +28,6 @@ module Jazzy
 
           targets.map do |t|
             args = %W[doc --module-name #{podspec.module_name} -- -target #{t}]
-            swift_version = compiler_swift_version(config.swift_version)
-            args << "SWIFT_VERSION=#{swift_version}"
             SourceKitten.run_sourcekitten(args)
           end
         end
@@ -107,13 +106,24 @@ module Jazzy
     # Go from a full Swift version like 4.2.1 to
     # something valid for SWIFT_VERSION.
     def compiler_swift_version(user_version)
-      return LATEST_SWIFT_VERSION unless user_version
+      unless user_version
+        return podspec_swift_version || LATEST_SWIFT_VERSION
+      end
 
       LONG_SWIFT_VERSIONS.select do |version|
         user_version.start_with?(version)
       end.last || "#{user_version[0]}.0"
     end
 
+    def podspec_swift_version
+      # `swift_versions` exists from CocoaPods 1.7
+      if podspec.respond_to?('swift_versions')
+        podspec.swift_versions.max
+      else
+        podspec.swift_version
+      end
+    end
+
     # @!group SourceKitten output helper methods
 
     def pod_path
@@ -124,7 +134,8 @@ module Jazzy
       end
     end
 
-    def podfile
+    # rubocop:disable Metrics/MethodLength
+    def podfile(swift_version)
       podspec = @podspec
       path = pod_path
       @podfile ||= Pod::Podfile.new do
@@ -133,8 +144,7 @@ module Jazzy
                  deterministic_uuids: false
 
         [podspec, *podspec.recursive_subspecs].each do |ss|
-          # test_specification exists from CocoaPods 1.3.0
-          next if ss.respond_to?('test_specification') && ss.test_specification
+          next if ss.test_specification
 
           ss.available_platforms.each do |p|
             # Travis builds take too long when building docs for all available
@@ -147,10 +157,12 @@ module Jazzy
               use_frameworks!
               platform p.name, p.deployment_target
               pod ss.name, path: path.realpath.to_s
+              current_target_definition.swift_version = swift_version
             end
           end
         end
       end
     end
+    # rubocop:enable Metrics/MethodLength
   end
 end

data/lib/jazzy/sourcekitten.rb

@@ -391,7 +391,8 @@ module Jazzy
         parsed &&
           (annotated.include?(' = default') || # SR-2608
            parsed.match('@autoclosure|@escaping') || # SR-6321
-           parsed.include?("\n"))
+           parsed.include?("\n") ||
+           parsed.include?('extension '))
     end
 
     # Replace the fully qualified name of a type with its base name

data/lib/jazzy/themes/apple/assets/css/jazzy.css.scss

@@ -337,6 +337,10 @@ header {
     padding-left: 3px;
     margin-left: 15px;
     font-size: 11.9px;
+    transition: all 300ms;
+  }
+  .token-open {
+    margin-left: 0px;
   }
   .discouraged {
     text-decoration: line-through;

data/lib/jazzy/themes/apple/assets/js/jazzy.js

@@ -8,29 +8,41 @@ if (navigator.userAgent.match(/xcode/i)) {
   window.jazzy.docset = true
 }
 
-// On doc load, toggle the URL hash discussion if present
-$(document).ready(function() {
-  if (!window.jazzy.docset) {
-    var linkToHash = $('a[href="' + window.location.hash +'"]');
-    linkToHash.trigger("click");
+function toggleItem($link, $content) {
+  var animationDuration = 300;
+  $link.toggleClass('token-open');
+  $content.slideToggle(animationDuration);
+}
+
+function itemLinkToContent($link) {
+  return $link.parent().parent().next();
+}
+
+// On doc load + hash-change, open any targetted item
+function openCurrentItemIfClosed() {
+  if (window.jazzy.docset) {
+    return;
   }
-});
+  var $link = $(`.token[href="${location.hash}"]`);
+  $content = itemLinkToContent($link);
+  if ($content.is(':hidden')) {
+    toggleItem($link, $content);
+  }
+}
 
-// On token click, toggle its discussion and animate token.marginLeft
-$(".token").click(function(event) {
+$(openCurrentItemIfClosed);
+$(window).on('hashchange', openCurrentItemIfClosed);
+
+// On item link ('token') click, toggle its discussion
+$('.token').on('click', function(event) {
   if (window.jazzy.docset) {
     return;
   }
-  var link = $(this);
-  var animationDuration = 300;
-  var tokenOffset = "15px";
-  var original = link.css('marginLeft') == tokenOffset;
-  link.animate({'margin-left':original ? "0px" : tokenOffset}, animationDuration);
-  $content = link.parent().parent().next();
-  $content.slideToggle(animationDuration);
+  var $link = $(this);
+  toggleItem($link, itemLinkToContent($link));
 
   // Keeps the document from jumping to the hash.
-  var href = $(this).attr('href');
+  var href = $link.attr('href');
   if (history.pushState) {
     history.pushState({}, '', href);
   } else {
@@ -38,3 +50,10 @@ $(".token").click(function(event) {
   }
   event.preventDefault();
 });
+
+// Clicks on links to the current, closed, item need to open the item
+$("a:not('.token')").on('click', function() {
+  if (location == this.href) {
+    openCurrentItemIfClosed();
+  }
+});

data/lib/jazzy/themes/apple/templates/header.mustache

@@ -1,6 +1,6 @@
 <header>
   <div class="content-wrapper">
-    <p><a href="{{path_to_root}}index.html">{{module_name}} Docs</a>{{#doc_coverage}} ({{doc_coverage}}% documented){{/doc_coverage}}</p>
+    <p><a href="{{path_to_root}}index.html">{{docs_title}}</a>{{#doc_coverage}} ({{doc_coverage}}% documented){{/doc_coverage}}</p>
     {{#github_url}}
     <p class="header-right"><a href="{{github_url}}"><img src="{{path_to_root}}img/gh.png"/>View on GitHub</a></p>
     {{/github_url}}

data/lib/jazzy/themes/fullwidth/assets/js/jazzy.js

@@ -8,26 +8,41 @@ if (navigator.userAgent.match(/xcode/i)) {
   window.jazzy.docset = true
 }
 
-// On doc load, toggle the URL hash discussion if present
-$(document).ready(function() {
-  if (!window.jazzy.docset) {
-    var linkToHash = $('a[href="' + window.location.hash +'"]');
-    linkToHash.trigger("click");
+function toggleItem($link, $content) {
+  var animationDuration = 300;
+  $link.toggleClass('token-open');
+  $content.slideToggle(animationDuration);
+}
+
+function itemLinkToContent($link) {
+  return $link.parent().parent().next();
+}
+
+// On doc load + hash-change, open any targetted item
+function openCurrentItemIfClosed() {
+  if (window.jazzy.docset) {
+    return;
   }
-});
+  var $link = $(`.token[href="${location.hash}"]`);
+  $content = itemLinkToContent($link);
+  if ($content.is(':hidden')) {
+    toggleItem($link, $content);
+  }
+}
 
-// On token click, toggle its discussion and animate token.marginLeft
-$(".token").click(function(event) {
+$(openCurrentItemIfClosed);
+$(window).on('hashchange', openCurrentItemIfClosed);
+
+// On item link ('token') click, toggle its discussion
+$('.token').on('click', function(event) {
   if (window.jazzy.docset) {
     return;
   }
-  var link = $(this);
-  var animationDuration = 300;
-  $content = link.parent().parent().next();
-  $content.slideToggle(animationDuration);
+  var $link = $(this);
+  toggleItem($link, itemLinkToContent($link));
 
   // Keeps the document from jumping to the hash.
-  var href = $(this).attr('href');
+  var href = $link.attr('href');
   if (history.pushState) {
     history.pushState({}, '', href);
   } else {
@@ -35,3 +50,10 @@ $(".token").click(function(event) {
   }
   event.preventDefault();
 });
+
+// Clicks on links to the current, closed, item need to open the item
+$("a:not('.token')").on('click', function() {
+  if (location == this.href) {
+    openCurrentItemIfClosed();
+  }
+});

data/lib/jazzy/themes/fullwidth/templates/header.mustache

@@ -1,7 +1,7 @@
 <header class="header">
   <p class="header-col header-col--primary">
     <a class="header-link" href="{{path_to_root}}index.html">
-      {{module_name}} Docs
+      {{docs_title}}
     </a>
     {{#doc_coverage}} ({{doc_coverage}}% documented){{/doc_coverage}}
   </p>

data/lib/jazzy/themes/jony/assets/css/jazzy.css.scss

@@ -375,10 +375,14 @@ header {
   .token, .direct-link {
     padding-left: 3px;
     margin-left: 35px;
+    transition: all 300ms;
   }
   .discouraged {
     text-decoration: line-through;
   }
+  .token-open {
+    margin-left: 25px;
+  }
   .declaration-note {
     font-size: .85em;
     color: rgba(128,128,128,1);

data/lib/jazzy/themes/jony/assets/js/jazzy.js

@@ -8,30 +8,41 @@ if (navigator.userAgent.match(/xcode/i)) {
   window.jazzy.docset = true
 }
 
-// On doc load, toggle the URL hash discussion if present
-$(document).ready(function() {
-  if (!window.jazzy.docset) {
-    var linkToHash = $('a[href="' + window.location.hash +'"]');
-    linkToHash.trigger("click");
+function toggleItem($link, $content) {
+  var animationDuration = 300;
+  $link.toggleClass('token-open');
+  $content.slideToggle(animationDuration);
+}
+
+function itemLinkToContent($link) {
+  return $link.parent().parent().next();
+}
+
+// On doc load + hash-change, open any targetted item
+function openCurrentItemIfClosed() {
+  if (window.jazzy.docset) {
+    return;
   }
-});
+  var $link = $(`.token[href="${location.hash}"]`);
+  $content = itemLinkToContent($link);
+  if ($content.is(':hidden')) {
+    toggleItem($link, $content);
+  }
+}
 
-// On token click, toggle its discussion and animate token.marginLeft
-$(".token").click(function(event) {
+$(openCurrentItemIfClosed);
+$(window).on('hashchange', openCurrentItemIfClosed);
+
+// On item link ('token') click, toggle its discussion
+$('.token').on('click', function(event) {
   if (window.jazzy.docset) {
     return;
   }
-  var link = $(this);
-  var animationDuration = 300;
-  var tokenOffset = "35px";
-  var selectedOffset = "25px";
-  var original = link.css('marginLeft') == tokenOffset;
-  link.animate({'margin-left':original ? selectedOffset : tokenOffset}, animationDuration);
-  $content = link.parent().parent().next();
-  $content.slideToggle(animationDuration);
+  var $link = $(this);
+  toggleItem($link, itemLinkToContent($link));
 
   // Keeps the document from jumping to the hash.
-  var href = $(this).attr('href');
+  var href = $link.attr('href');
   if (history.pushState) {
     history.pushState({}, '', href);
   } else {
@@ -39,3 +50,10 @@ $(".token").click(function(event) {
   }
   event.preventDefault();
 });
+
+// Clicks on links to the current, closed, item need to open the item
+$("a:not('.token')").on('click', function() {
+  if (location == this.href) {
+    openCurrentItemIfClosed();
+  }
+});

data/lib/jazzy/themes/jony/templates/header.mustache

@@ -1,7 +1,7 @@
 <header>
   <div class="content-wrapper">
     <p>
-      <a href="{{path_to_root}}index.html">{{module_name}} Docs</a>
+      <a href="{{path_to_root}}index.html">{{docs_title}}</a>
       <span class="no-mobile">{{#doc_coverage}} ({{doc_coverage}}% documented){{/doc_coverage}}</span>
     </p>
 

data/spec/integration_spec.rb

@@ -103,6 +103,7 @@ describe_cli 'jazzy' do
       'JAZZY_FAKE_VERSION'         => 'X.X.X',
       'COCOAPODS_SKIP_UPDATE_MESSAGE' => 'TRUE',
       'JAZZY_INTEGRATION_SPECS' => 'TRUE',
+      'JAZZY_FAKE_MODULE_VERSION' => 'Y.Y.Y',
     }
     s.default_args = []
     s.replace_path ROOT.to_s, 'ROOT'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jazzy
 version: !ruby/object:Gem::Version
-  version: 0.9.6
+  version: 0.10.0
 platform: ruby
 authors:
 - JP Simard
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-03 00:00:00.000000000 Z
+date: 2019-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cocoapods
@@ -18,28 +18,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.3
+        version: '1.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.3
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: mustache
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: open4
   requirement: !ruby/object:Gem::Requirement
@@ -60,14 +60,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: '3.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: '3.4'
 - !ruby/object:Gem::Dependency
   name: rouge
   requirement: !ruby/object:Gem::Requirement
@@ -94,28 +94,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.6.0
+        version: '3.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.6.0
+        version: '3.6'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.13
+        version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.13
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: xcinvoke
   requirement: !ruby/object:Gem::Requirement