jazzy 0.8.3 → 0.8.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9b6c8d617080bf1a2a5d1930f3c63c630da8869e
-  data.tar.gz: 558a557588f533343725d3efc06cf7c00d25e241
+  metadata.gz: 521ac7a49708dd60f61fd8a5be45a0cabeadab01
+  data.tar.gz: d92a5318703bcdc5b70a30b02147c1b6318a5207
 SHA512:
-  metadata.gz: 22f290f2559756550a4122c9338528d6d0b9a21a66f5d4f2906e1f35d0c8f7f20d3ecc2285a88a900619d5d17170fb70548ed971de1bde3d08045b5ab026392d
-  data.tar.gz: 87ac65fd0994caf9229c76d6c68e837b0fa167863d213a33834be1c16f6d8212703fcce5ca2d8219a9573407432447aaf9597beead518877b67235c6b5a3d1ad
+  metadata.gz: 4fbcffeba3be993af19ca581792fc18c2cef463df918ab0f0f7f5f76b04a09494d7dd7066c1b4a3a3125102178660cc4278f985d2becf2c9974eb32340c14004
+  data.tar.gz: 54f4db86a1b320ec74f98992c26757a4dc5fdd25e350942678d51bc0b15ab6910e6b0d2e3a8f5bd2d2f2eb172244039233ecbdf255c5bfecf0e1bd0ba6aa64f7

data/CHANGELOG.md

@@ -1,3 +1,36 @@
+## 0.8.4
+
+##### Breaking
+
+* None.
+
+##### Enhancements
+
+* Align jazzy terminology with Apple usage.  
+  [Xiaodi Wu](https://github.com/xwu)
+  [John Fairhurst](https://github.com/johnfairh)
+
+* Add `url` attribute that can be more accurate than `{{section}}.html` as a URL
+  in custom templates.  
+  [John Fairhurst](https://github.com/johnfairh)
+
+##### Bug Fixes
+
+* Fix crash when specifying `swift_version` as a floating point value in
+  `.jazzy.yaml` rather than a string.  
+  [JP Simard](https://github.com/jpsim)
+  [#860](https://github.com/realm/jazzy/issues/860)
+
+* Autolink from parameter documentation and from external markdown documents
+  including README.  Autolink to symbols containing & < >.  
+  [John Fairhurst](https://github.com/johnfairh)
+  [#715](https://github.com/realm/jazzy/issues/715)
+  [#789](https://github.com/realm/jazzy/issues/789)
+  [#805](https://github.com/realm/jazzy/issues/805)
+
+* Fix Swift 4 declarations containing ampersands (`&`) being truncated.  
+  [JP Simard](https://github.com/jpsim)
+
 ## 0.8.3
 
 ##### Breaking

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    jazzy (0.8.3)
+    jazzy (0.8.4)
       cocoapods (~> 1.0)
       mustache (~> 0.99)
       open4
@@ -15,7 +15,7 @@ GEM
   remote: https://rubygems.org/
   specs:
     CFPropertyList (2.3.5)
-    activesupport (4.2.8)
+    activesupport (4.2.9)
       i18n (~> 0.7)
       minitest (~> 5.1)
       thread_safe (~> 0.3, >= 0.3.4)
@@ -88,16 +88,17 @@ GEM
       multipart-post (>= 1.2, < 3)
     faraday-http-cache (1.3.1)
       faraday (~> 0.8)
+    ffi (1.9.18)
     fourflusher (2.0.1)
     fuzzy_match (2.0.4)
     gh_inspector (1.0.3)
     git (1.3.0)
     hashdiff (0.3.4)
-    i18n (0.8.1)
+    i18n (0.8.6)
     kramdown (1.13.2)
     liferaft (0.0.6)
     metaclass (0.0.4)
-    minitest (5.10.2)
+    minitest (5.10.3)
     mocha (1.2.1)
       metaclass (~> 0.0.1)
     mocha-on-bacon (0.2.3)
@@ -120,6 +121,9 @@ GEM
     rainbow (2.2.2)
       rake
     rake (10.5.0)
+    rb-fsevent (0.10.2)
+    rb-inotify (0.9.10)
+      ffi (>= 0.5.0, < 2)
     redcarpet (3.4.0)
     rouge (1.11.1)
     rubocop (0.48.1)
@@ -131,7 +135,11 @@ GEM
     ruby-macho (1.1.0)
     ruby-progressbar (1.8.1)
     safe_yaml (1.0.4)
-    sass (3.4.24)
+    sass (3.5.1)
+      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)
@@ -172,4 +180,4 @@ DEPENDENCIES
   webmock
 
 BUNDLED WITH
-   1.14.6
+   1.15.4

data/README.md

@@ -49,12 +49,22 @@ all available options, run `jazzy --help config`.
 
 ### Supported keywords
 
-Swift header 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*](http://ericasadun.com/2015/06/14/swift-header-documentation-in-xcode-7/)
-and her [book on Swift Documentation Markup](https://itunes.apple.com/us/book/swift-documentation-markup/id1049010423).
+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*](http://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/).
 
 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.**
+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.**
+
+Jazzy can also generate cross-references within your documentation. A symbol name in
+backticks generates a link, for example:
+* \`MyClass\` - a link to documentation for `MyClass`.
+* \`MyClass.method(param1:)\` - a link to documentation for that method.
+* \`MyClass.method(...)\` - shortcut syntax for the same thing.
+* \`method(...)\` - shortcut syntax to link to `method` from the documentation of another
+  method or property in the same class.
+* \`[MyClass method1]\` - a link to an Objective-C method.
+* \`-[MyClass method2:param1]\` - a link to another Objective-C method.
 
 ### Swift
 
@@ -171,15 +181,40 @@ This is very helpful when using `custom_categories` for grouping types and inclu
 
 For an example of a project using both `--documentation` and `--abstract` see: [http://reswift.github.io/ReSwift/](http://reswift.github.io/ReSwift/)
 
+### Controlling what is documented
+
+In Swift mode, Jazzy by default documents only `public` and `open` declarations. To
+include declarations with a lower access level, set the `--min-acl` flag to `internal`,
+`fileprivate`, or `private`.
+
+In Objective-C mode, Jazzy documents all declarations found in the `--umbrella-header`
+header file and any other header files included by it.
+
+You can then prevent some of these declarations from being documented using `--exclude`
+or `:nodoc:`.
+
+The `--exclude` flag lists source files to omit from the documentation. Entries in the
+list can be absolute pathnames beginning with `/` or relative pathnames. Relative
+pathnames are interpreted relative to the directory from where you run `jazzy` or, if the
+exclude flag is set in the config file, relative to the directory containing the config
+file. Entries in the list can match multiple files using `*` to match any number of
+characters including `/`.  For example:
+* `jazzy --exclude=/Users/fred/project/Sources/Secret.swift` -- exclude a specific file
+* `jazzy --exclude=/*/Internal*` -- exclude all files with names that begin with *Internal*
+  and any files under any directory with a name beginning *Internal*.
+* `jazzy --exclude=Impl1/*,Impl2/*` -- exclude all files under the directories *Impl1* and
+  *Impl2* found in the current directory.
+
+Declarations with a documentation comment containing `:nodoc:` are excluded from the
+documentation.
+
 ## Troubleshooting
 
 #### Swift
 
 **Only extensions are listed in the documentation?**
 
-By default, `jazzy` only documents public declarations. To generate documentation
-for declarations with a lower accessibility level (`internal` or `private`), please
-set the `--min-acl` flag to `internal` or `private`.
+Check the `--min-acl` setting -- see [above](#controlling-what-is-documented).
 
 ## Development
 

data/circle.yml

@@ -1,6 +1,6 @@
 machine:
   xcode:
-    version: "8.3.2"
+    version: "9.0"
 
 checkout:
   post:

data/lib/jazzy/config.rb

@@ -150,8 +150,8 @@ module Jazzy
       parse: ->(sd) { expand_path(sd) }
 
     config_attr :excluded_files,
-      command_line: ['-e', '--exclude file1,file2,directory3,…fileN', Array],
-      description: 'Files/directories to be excluded from documentation. '\
+      command_line: ['-e', '--exclude filepath1,filepath2,…filepathN', Array],
+      description: 'Source file pathnames to be excluded from documentation. '\
                    'Supports wildcards.',
       default: [],
       parse: ->(files) do
@@ -162,7 +162,7 @@ module Jazzy
       command_line: '--swift-version VERSION',
       default: nil,
       parse: ->(v) do
-        return nil if v.empty?
+        return nil if v.to_s.empty?
         raise 'jazzy only supports Swift 2.0 or later.' if v.to_f < 2
         v
       end

data/lib/jazzy/doc_builder.rb

@@ -46,6 +46,7 @@ module Jazzy
         end
         {
           section: doc.name,
+          url: doc.url,
           children: children,
         }
       end
@@ -208,6 +209,11 @@ module Jazzy
       end
     end
 
+    def self.render(doc_model, markdown)
+      html = Markdown.render(markdown)
+      SourceKitten.autolink_document(html, doc_model)
+    end
+
     # Build Mustache document from a markdown source file
     # @param [Config] options Build options
     # @param [Hash] doc_model Parsed doc. @see SourceKitten.parse
@@ -218,7 +224,7 @@ module Jazzy
       doc = Doc.new # Mustache model instance
       name = doc_model.name == 'index' ? source_module.name : doc_model.name
       doc[:name] = name
-      doc[:overview] = Markdown.render(doc_model.content(source_module))
+      doc[:overview] = render(doc_model, doc_model.content(source_module))
       doc[:custom_head] = Config.instance.custom_head
       doc[:disable_search] = Config.instance.disable_search
       doc[:doc_coverage] = source_module.doc_coverage unless
@@ -230,7 +236,7 @@ module Jazzy
       doc[:dash_url] = source_module.dash_url
       doc[:path_to_root] = path_to_root
       doc[:hide_name] = true
-      doc.render
+      doc.render.gsub(ELIDED_AUTOLINK_TOKEN, path_to_root)
     end
 
     # Returns the appropriate color for the provided percentage,
@@ -365,7 +371,7 @@ module Jazzy
       overview = (doc_model.abstract || '') + (doc_model.discussion || '')
       alternative_abstract = doc_model.alternative_abstract
       if alternative_abstract
-        overview = Markdown.render(alternative_abstract) + overview
+        overview = render(doc_model, alternative_abstract) + overview
       end
 
       doc = Doc.new # Mustache model instance

data/lib/jazzy/gem_version.rb

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

data/lib/jazzy/podspec_documenter.rb

@@ -2,6 +2,7 @@ require 'tmpdir'
 require 'json'
 
 module Jazzy
+  # rubocop:disable Metrics/ClassLength
   class PodspecDocumenter
     attr_reader :podspec
 
@@ -14,7 +15,8 @@ module Jazzy
     def sourcekitten_output(config)
       installation_root = Pathname(Dir.mktmpdir(['jazzy', podspec.name]))
       installation_root.rmtree if installation_root.exist?
-      Pod::Config.instance.with_changes(installation_root: installation_root) do
+      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)
         installer.install!
@@ -25,7 +27,7 @@ module Jazzy
 
           targets.map do |t|
             args = %W[doc --module-name #{podspec.module_name} -- -target #{t}]
-            swift_version = (config.swift_version || '3')[0] + '.0'
+            swift_version = (config.swift_version || '4')[0] + '.0'
             args << "SWIFT_VERSION=\"#{swift_version}\""
             SourceKitten.run_sourcekitten(args)
           end
@@ -117,8 +119,12 @@ module Jazzy
           ss.available_platforms.each do |p|
             # Travis builds take too long when building docs for all available
             # platforms for the Moya integration spec, so we just document OSX.
+            # Also Moya's RxSwift subspec doesn't yet support Swift 4, so skip
+            # that too while we're at it.
             # TODO: remove once jazzy is fast enough.
-            next if ENV['JAZZY_INTEGRATION_SPECS'] && p.name != :osx
+            if ENV['JAZZY_INTEGRATION_SPECS']
+              next if (p.name != :osx) || (ss.name == 'Moya/RxSwift')
+            end
             target("Jazzy-#{ss.name.gsub('/', '__')}-#{p.name}") do
               use_frameworks!
               platform p.name, p.deployment_target

data/lib/jazzy/source_declaration.rb

@@ -76,6 +76,7 @@ module Jazzy
     attr_accessor :start_line
     attr_accessor :end_line
     attr_accessor :nav_order
+    attr_accessor :url_name
 
     def alternative_abstract
       if file = alternative_abstract_file
@@ -85,7 +86,8 @@ module Jazzy
 
     def alternative_abstract_file
       abstract_glob.select do |f|
-        File.basename(f).split('.').first == name
+        # allow Structs.md or Structures.md
+        [name, url_name].include?(File.basename(f).split('.').first)
       end.first
     end
 

data/lib/jazzy/source_declaration/type.rb

@@ -23,6 +23,11 @@ module Jazzy
         @type && @type[:jazzy]
       end
 
+      # name to use for type subdirectory in URLs for back-compatibility
+      def url_name
+        @type && (@type[:url] || @type[:jazzy])
+      end
+
       def name_controlled_manually?
         !kind.start_with?('source')
         # "'source'.lang..." for Swift
@@ -34,6 +39,10 @@ module Jazzy
         name.pluralize
       end
 
+      def plural_url_name
+        url_name.pluralize
+      end
+
       def mark?
         kind == 'source.lang.swift.syntaxtype.comment.mark' ||
           kind == 'sourcekitten.source.lang.objc.mark'
@@ -137,11 +146,12 @@ module Jazzy
           dash: 'Constant',
         }.freeze,
         'sourcekitten.source.lang.objc.decl.enum' => {
-          jazzy: 'Enum',
+          jazzy: 'Enumeration',
+          url: 'Enum',
           dash: 'Enum',
         }.freeze,
         'sourcekitten.source.lang.objc.decl.enumcase' => {
-          jazzy: 'Enum Case',
+          jazzy: 'Enumeration Case',
           dash: 'Case',
         }.freeze,
         'sourcekitten.source.lang.objc.decl.initializer' => {
@@ -177,7 +187,8 @@ module Jazzy
           dash: 'Function',
         }.freeze,
         'sourcekitten.source.lang.objc.decl.struct' => {
-          jazzy: 'Struct',
+          jazzy: 'Structure',
+          url: 'Struct',
           dash: 'Struct',
         }.freeze,
         'sourcekitten.source.lang.objc.decl.field' => {
@@ -185,7 +196,7 @@ module Jazzy
           dash: 'Field',
         }.freeze,
         'sourcekitten.source.lang.objc.decl.ivar' => {
-          jazzy: 'Ivar',
+          jazzy: 'Instance Variable',
           dash: 'Ivar',
         }.freeze,
         'sourcekitten.source.lang.objc.module.import' => {
@@ -195,27 +206,27 @@ module Jazzy
 
         # Swift
         'source.lang.swift.decl.function.accessor.address' => {
-          jazzy: 'Address Accessor',
+          jazzy: 'Addressor',
           dash: 'Function',
         }.freeze,
         'source.lang.swift.decl.function.accessor.didset' => {
-          jazzy: 'DidSet Accessor',
+          jazzy: 'didSet Observer',
           dash: 'Function',
         }.freeze,
         'source.lang.swift.decl.function.accessor.getter' => {
-          jazzy: 'Getter Accessor',
+          jazzy: 'Getter',
           dash: 'Function',
         }.freeze,
         'source.lang.swift.decl.function.accessor.mutableaddress' => {
-          jazzy: 'Mutable Address Accessor',
+          jazzy: 'Mutable Addressor',
           dash: 'Function',
         }.freeze,
         'source.lang.swift.decl.function.accessor.setter' => {
-          jazzy: 'Setter Accessor',
+          jazzy: 'Setter',
           dash: 'Function',
         }.freeze,
         'source.lang.swift.decl.function.accessor.willset' => {
-          jazzy: 'WillSet Accessor',
+          jazzy: 'willSet Observer',
           dash: 'Function',
         }.freeze,
         'source.lang.swift.decl.function.operator' => {
@@ -247,11 +258,11 @@ module Jazzy
           dash: 'Class',
         }.freeze,
         'source.lang.swift.decl.function.constructor' => {
-          jazzy: 'Constructor',
+          jazzy: 'Initializer',
           dash: 'Constructor',
         }.freeze,
         'source.lang.swift.decl.function.destructor' => {
-          jazzy: 'Destructor',
+          jazzy: 'Deinitializer',
           dash: 'Method',
         }.freeze,
         'source.lang.swift.decl.var.global' => {
@@ -259,15 +270,16 @@ module Jazzy
           dash: 'Global',
         }.freeze,
         'source.lang.swift.decl.enumcase' => {
-          jazzy: 'Enum Case',
+          jazzy: 'Enumeration Case',
           dash: 'Case',
         }.freeze,
         'source.lang.swift.decl.enumelement' => {
-          jazzy: 'Enum Element',
+          jazzy: 'Enumeration Element',
           dash: 'Element',
         }.freeze,
         'source.lang.swift.decl.enum' => {
-          jazzy: 'Enum',
+          jazzy: 'Enumeration',
+          url: 'Enum',
           dash: 'Enum',
         }.freeze,
         'source.lang.swift.decl.extension' => {
@@ -279,7 +291,7 @@ module Jazzy
           dash: 'Extension',
         }.freeze,
         'source.lang.swift.decl.extension.enum' => {
-          jazzy: 'Enum Extension',
+          jazzy: 'Enumeration Extension',
           dash: 'Extension',
         }.freeze,
         'source.lang.swift.decl.extension.protocol' => {
@@ -287,7 +299,7 @@ module Jazzy
           dash: 'Extension',
         }.freeze,
         'source.lang.swift.decl.extension.struct' => {
-          jazzy: 'Struct Extension',
+          jazzy: 'Structure Extension',
           dash: 'Extension',
         }.freeze,
         'source.lang.swift.decl.function.free' => {
@@ -323,7 +335,8 @@ module Jazzy
           dash: 'Variable',
         }.freeze,
         'source.lang.swift.decl.struct' => {
-          jazzy: 'Struct',
+          jazzy: 'Structure',
+          url: 'Struct',
           dash: 'Struct',
         }.freeze,
         'source.lang.swift.decl.function.subscript' => {
@@ -331,7 +344,8 @@ module Jazzy
           dash: 'Method',
         }.freeze,
         'source.lang.swift.decl.typealias' => {
-          jazzy: 'Typealias',
+          jazzy: 'Type Alias',
+          url: 'Typealias',
           dash: 'Alias',
         }.freeze,
         'source.lang.swift.decl.generic_type_param' => {

data/lib/jazzy/sourcekitten.rb

@@ -2,6 +2,7 @@ require 'json'
 require 'pathname'
 require 'shellwords'
 require 'xcinvoke'
+require 'CGI'
 
 require 'jazzy/config'
 require 'jazzy/executable'
@@ -27,7 +28,7 @@ class String
     gsub(autolink_regex(middle_regex, after_highlight)) do
       original = Regexp.last_match(0)
       start_tag, raw_name, end_tag = Regexp.last_match.captures
-      link_target = yield(raw_name)
+      link_target = yield(CGI.unescape_html(raw_name))
 
       if link_target &&
          !link_target.type.extension? &&
@@ -82,17 +83,19 @@ module Jazzy
           children,
           type_category_prefix + type.plural_name,
           "The following #{type.plural_name.downcase} are available globally.",
+          type_category_prefix + type.plural_url_name,
         )
       end
       [group.compact, docs]
     end
 
-    def self.make_group(group, name, abstract)
+    def self.make_group(group, name, abstract, url_name = nil)
       group.reject! { |doc| doc.name.empty? }
       unless group.empty?
         SourceDeclaration.new.tap do |sd|
           sd.type     = SourceDeclaration::Type.overview
           sd.name     = name
+          sd.url_name = url_name
           sd.abstract = Markdown.render(abstract)
           sd.children = group
         end
@@ -100,7 +103,7 @@ module Jazzy
     end
 
     def self.sanitize_filename(doc)
-      unsafe_filename = doc.name
+      unsafe_filename = doc.url_name || doc.name
       sanitzation_enabled = Config.instance.use_safe_filenames
       if sanitzation_enabled && !doc.type.name_controlled_manually?
         return CGI.escape(unsafe_filename).gsub('_', '%5F').tr('%', '_')
@@ -154,7 +157,8 @@ module Jazzy
       top_level_decl = doc.namespace_path.first
       if top_level_decl && top_level_decl.type && top_level_decl.type.name
         # File program elements under top ancestor’s type (Struct, Class, etc.)
-        [top_level_decl.type.plural_name] + doc.namespace_ancestors.map(&:name)
+        [top_level_decl.type.plural_url_name] +
+          doc.namespace_ancestors.map(&:name)
       else
         # Categories live in their own directory
         []
@@ -294,7 +298,7 @@ module Jazzy
           name: name,
           discussion: discovered[name],
         }
-      end
+      end.reject { |param| param[:discussion].nil? }
     end
 
     # rubocop:disable Metrics/CyclomaticComplexity
@@ -540,7 +544,7 @@ module Jazzy
       return nil unless name_part
       wildcard_expansion = Regexp.escape(name_part)
                                  .gsub('\.\.\.', '[^)]*')
-                                 .gsub(/<.*>/, '')
+                                 .gsub(/<.*>/, '')
       whole_name_pat = /\A#{wildcard_expansion}\Z/
       docs.find do |doc|
         whole_name_pat =~ doc.name
@@ -602,11 +606,16 @@ module Jazzy
     end
 
     def self.autolink(docs, root_decls)
+      @autolink_root_decls = root_decls
       docs.each do |doc|
         doc.children = autolink(doc.children, root_decls)
 
         doc.return = autolink_text(doc.return, doc, root_decls) if doc.return
         doc.abstract = autolink_text(doc.abstract, doc, root_decls)
+        (doc.parameters || []).each do |param|
+          param[:discussion] =
+            autolink_text(param[:discussion], doc, root_decls)
+        end
 
         if doc.declaration
           doc.declaration = autolink_text(
@@ -622,6 +631,11 @@ module Jazzy
       end
     end
 
+    # For autolinking external markdown documents
+    def self.autolink_document(html, doc)
+      autolink_text(html, doc, @autolink_root_decls || [])
+    end
+
     def self.reject_objc_types(docs)
       enums = docs.map do |doc|
         [doc, doc.children]

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

@@ -2,7 +2,7 @@
   <ul class="nav-groups">
     {{#structure}}
     <li class="nav-group-name">
-      <a href="{{path_to_root}}{{section}}.html">{{section}}</a>
+      <a href="{{path_to_root}}{{url}}">{{section}}</a>
       <ul class="nav-group-tasks">
         {{#children}}
         <li class="nav-group-task">

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

@@ -2,7 +2,7 @@
   <ul class="nav-groups">
     {{#structure}}
     <li class="nav-group-name">
-      <a class="nav-group-name-link" href="{{path_to_root}}{{section}}.html">{{section}}</a>
+      <a class="nav-group-name-link" href="{{path_to_root}}{{url}}">{{section}}</a>
       <ul class="nav-group-tasks">
         {{#children}}
         <li class="nav-group-task">

data/spec/integration_spec.rb

@@ -106,7 +106,7 @@ describe_cli 'jazzy' do
     s.replace_pattern /^[\d\s:.-]+ ruby\[\d+:\d+\] warning:.*$[\n]?/, ''
     # Remove version numbers from CocoaPods dependencies
     # to make specs resilient against dependecy updates.
-    s.replace_pattern /(Installing \w+ )\((.*)\)/, '\1(X.Y.Z)'
+    s.replace_pattern(/(Installing \w+ )\((.*)\)/, '\1(X.Y.Z)')
   end
 
   require 'shellwords'
@@ -208,8 +208,8 @@ describe_cli 'jazzy' do
       behaves_like cli_spec 'document_siesta',
                             # Siesta already has Docs/
                             '--output api-docs',
-                            # Use default Swift rather than the specified 3.0.2
-                            '--swift-version='
+                            # Use Swift 4 rather than the specified 3.0.2
+                            '--swift-version=4'
     end
 
     describe 'Creates docs for Swift project with a variety of contents' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jazzy
 version: !ruby/object:Gem::Version
-  version: 0.8.3
+  version: 0.8.4
 platform: ruby
 authors:
 - JP Simard
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-07 00:00:00.000000000 Z
+date: 2017-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cocoapods
@@ -259,7 +259,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Soulful docs for Swift & Objective-C.