jazzy 0.9.4 → 0.9.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f3b6a6bd1f08daea4c0cabeed1607b0c4ab3d70b
-  data.tar.gz: 69b661bafc0c0cb2f19d9fe01b5d483f0f272d2d
+  metadata.gz: f5a0f16d2a7503e43f28a7eff101228617d44ed4
+  data.tar.gz: e423b906a68d413d3c8e63ce0c7961b5e88da272
 SHA512:
-  metadata.gz: 0b08613b7a92b0dec87e096e979dbe57882ee7fec15a02afab20788b9f127d273d76fdd60b2288928afa5340b82f5a72ba5910e436a395083f14cb73e5d5c3b4
-  data.tar.gz: 4435f590f247b0dad8f3cbae02727c794a59a3b54595cfa8878c6e8e4c6f6ca59103d286ada3ff35cdd2ffd05575d85718054251526481feb0e7330b12be3a73
+  metadata.gz: ceff92f660c07d63dfd1bf95c6b9928c7ab56fbe8ec8899d37d275248510d2a79c691fc8c83cdb5dfe5516926009ddd10162c48e74898a37613be2cbfd043299
+  data.tar.gz: 21f47afdaadb40618d31c8b0597c698688adc7c2cd64a152d58d3feea0cf47e5607720ac743730bb5b9191cd970c8fdfb63c5270b8775fe6754e813e04a06985

data/CHANGELOG.md

@@ -1,3 +1,31 @@
+## 0.9.5
+
+##### Breaking
+
+* None.
+
+##### Enhancements
+
+* Link to documentation pages from contents pages.  
+  [John Fairhurst](https://github.com/johnfairh)
+  [#730](https://github.com/realm/jazzy/issues/730)
+
+* Call out unavailable and deprecated Objective-C declarations.  
+  [Stefan Kieleithner](https://github.com/steviki)
+  [John Fairhurst](https://github.com/johnfairh)
+  [#843](https://github.com/realm/jazzy/issues/843)
+
+##### Bug Fixes
+
+* Support Swift 4.2 with `--podspec`.  
+  [John Fairhurst](https://github.com/johnfairh)
+  [#1015](https://github.com/realm/jazzy/issues/1015)
+
+* Fix multiline copyright for `apple` theme.  
+  [Fabien Lydoire](https://github.com/fabienlydoire)
+  [John Fairhurst](https://github.com/johnfairh)
+  [#1016](https://github.com/realm/jazzy/issues/1016)
+
 ## 0.9.4
 
 ##### Breaking

data/Gemfile.lock

@@ -1,21 +1,21 @@
 PATH
   remote: .
   specs:
-    jazzy (0.9.4)
-      cocoapods (~> 1.0)
-      mustache (~> 0.99)
+    jazzy (0.9.5)
+      cocoapods (~> 1.5.3)
+      mustache (~> 1.1.0)
       open4
-      redcarpet (~> 3.2)
+      redcarpet (~> 3.4.0)
       rouge (>= 2.0.6, < 4.0)
-      sass (~> 3.4)
-      sqlite3 (~> 1.3)
+      sass (~> 3.6.0)
+      sqlite3 (~> 1.3.13)
       xcinvoke (~> 0.3.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     CFPropertyList (3.0.0)
-    activesupport (4.2.10)
+    activesupport (4.2.11)
       i18n (~> 0.7)
       minitest (~> 5.1)
       thread_safe (~> 0.3, >= 0.3.4)
@@ -23,7 +23,7 @@ GEM
     addressable (2.5.2)
       public_suffix (>= 2.0.2, < 4.0)
     ast (2.4.0)
-    atomos (0.1.2)
+    atomos (0.1.3)
     bacon (1.2.0)
     claide (1.0.2)
     claide-plugins (0.9.2)
@@ -33,10 +33,10 @@ GEM
     clintegracon (0.7.0)
       colored (~> 1.2)
       diffy
-    cocoapods (1.5.0)
+    cocoapods (1.5.3)
       activesupport (>= 4.0.2, < 5)
       claide (>= 1.0.2, < 2.0)
-      cocoapods-core (= 1.5.0)
+      cocoapods-core (= 1.5.3)
       cocoapods-deintegrate (>= 1.0.2, < 2.0)
       cocoapods-downloader (>= 1.2.0, < 2.0)
       cocoapods-plugins (>= 1.0.0, < 2.0)
@@ -52,86 +52,86 @@ GEM
       nap (~> 1.0)
       ruby-macho (~> 1.1)
       xcodeproj (>= 1.5.7, < 2.0)
-    cocoapods-core (1.5.0)
+    cocoapods-core (1.5.3)
       activesupport (>= 4.0.2, < 6)
       fuzzy_match (~> 2.0.4)
       nap (~> 1.0)
     cocoapods-deintegrate (1.0.2)
-    cocoapods-downloader (1.2.0)
+    cocoapods-downloader (1.2.2)
     cocoapods-plugins (1.0.0)
       nap
     cocoapods-search (1.0.0)
-    cocoapods-stats (1.0.0)
-    cocoapods-trunk (1.3.0)
+    cocoapods-stats (1.1.0)
+    cocoapods-trunk (1.3.1)
       nap (>= 0.8, < 2.0)
       netrc (~> 0.11)
     cocoapods-try (1.1.0)
     colored (1.2)
     colored2 (3.1.2)
-    concurrent-ruby (1.0.5)
+    concurrent-ruby (1.1.4)
     cork (0.3.0)
       colored2 (~> 3.1)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
-    danger (5.5.12)
+    danger (5.11.1)
       claide (~> 1.0)
       claide-plugins (>= 0.9.2)
       colored2 (~> 3.1)
       cork (~> 0.1)
       faraday (~> 0.9)
       faraday-http-cache (~> 1.0)
-      git (~> 1)
+      git (~> 1.5)
       kramdown (~> 1.5)
       no_proxy_fix
       octokit (~> 4.7)
       terminal-table (~> 1)
-    diffy (3.2.0)
+    diffy (3.3.0)
     escape (0.0.4)
-    faraday (0.15.0)
+    faraday (0.15.4)
       multipart-post (>= 1.2, < 3)
     faraday-http-cache (1.3.1)
       faraday (~> 0.8)
-    ffi (1.9.23)
+    ffi (1.10.0)
     fourflusher (2.0.1)
     fuzzy_match (2.0.4)
     gh_inspector (1.1.3)
-    git (1.3.0)
-    hashdiff (0.3.7)
+    git (1.5.0)
+    hashdiff (0.3.8)
     i18n (0.9.5)
       concurrent-ruby (~> 1.0)
-    kramdown (1.16.2)
+    kramdown (1.17.0)
     liferaft (0.0.6)
     metaclass (0.0.4)
     minitest (5.11.3)
-    mocha (1.5.0)
+    mocha (1.8.0)
       metaclass (~> 0.0.1)
     mocha-on-bacon (0.2.3)
       mocha (>= 0.13.0)
-    molinillo (0.6.5)
+    molinillo (0.6.6)
     multipart-post (2.0.0)
-    mustache (0.99.8)
-    nanaimo (0.2.5)
+    mustache (1.1.0)
+    nanaimo (0.2.6)
     nap (1.1.0)
     netrc (0.11.0)
     no_proxy_fix (0.1.2)
-    octokit (4.8.0)
+    octokit (4.13.0)
       sawyer (~> 0.8.0, >= 0.5.3)
     open4 (1.3.4)
-    parallel (1.12.1)
-    parser (2.5.1.0)
+    parallel (1.13.0)
+    parser (2.6.0.0)
       ast (~> 2.4.0)
-    powerpack (0.1.1)
+    powerpack (0.1.2)
     prettybacon (0.0.2)
       bacon (~> 1.2)
-    public_suffix (3.0.2)
+    public_suffix (3.0.3)
     rainbow (2.2.2)
       rake
     rake (10.5.0)
     rb-fsevent (0.10.3)
-    rb-inotify (0.9.10)
-      ffi (>= 0.5.0, < 2)
+    rb-inotify (0.10.0)
+      ffi (~> 1.0)
     redcarpet (3.4.0)
-    rouge (3.1.1)
+    rouge (3.3.0)
     rubocop (0.49.0)
       parallel (~> 1.10)
       parser (>= 2.3.3.1, < 3.0)
@@ -139,10 +139,10 @@ GEM
       rainbow (>= 1.99.1, < 3.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.0, >= 1.0.1)
-    ruby-macho (1.1.0)
-    ruby-progressbar (1.9.0)
+    ruby-macho (1.3.1)
+    ruby-progressbar (1.10.0)
     safe_yaml (1.0.4)
-    sass (3.5.6)
+    sass (3.6.0)
       sass-listen (~> 4.0.0)
     sass-listen (4.0.0)
       rb-fsevent (~> 0.9, >= 0.9.4)
@@ -156,19 +156,19 @@ GEM
     thread_safe (0.3.6)
     tzinfo (1.2.5)
       thread_safe (~> 0.1)
-    unicode-display_width (1.3.2)
-    webmock (3.3.0)
+    unicode-display_width (1.4.1)
+    webmock (3.5.1)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff
     xcinvoke (0.3.0)
       liferaft (~> 0.0.6)
-    xcodeproj (1.5.7)
+    xcodeproj (1.7.0)
       CFPropertyList (>= 2.3.3, < 4.0)
-      atomos (~> 0.1.2)
+      atomos (~> 0.1.3)
       claide (>= 1.0.2, < 2.0)
       colored2 (~> 3.1)
-      nanaimo (~> 0.2.4)
+      nanaimo (~> 0.2.6)
 
 PLATFORMS
   ruby
@@ -188,4 +188,4 @@ DEPENDENCIES
   webmock
 
 BUNDLED WITH
-   1.16.0
+   1.17.3

data/README.md

@@ -33,9 +33,8 @@ document. It must be installed in a location indexed by Spotlight for the
 [sudo] gem install jazzy
 ```
 
-The Xcode command-line developer tools must be installed to successfully build
-the gems that `jazzy` depends on: try `xcode-select --install` if you see build
-errors.
+See [Installation Problems](#installation-problems) for solutions to some
+common problems.
 
 ## Usage
 
@@ -166,7 +165,7 @@ Any files found matching the file pattern will be parsed and included as a docum
 
 There are a few limitations:
 - File names must be unique from source files.
-- Readme should be specified separately using the `readme_path` option.
+- Readme should be specified separately using the `readme` option.
 
 ### Section description abstracts
 
@@ -220,6 +219,20 @@ 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.
 
+### Choosing the Swift language version
+
+Jazzy normally uses the Swift compiler from the Xcode currently configured by
+`xcode-select`.  Use the `--swift-version` flag to compile with a different
+Xcode.
+
+The value you pass to `--swift-version` must be the Swift language version given
+by `swift --version` in the Xcode you want to use.
+
+For example to use Xcode 9.4:
+```shell
+jazzy --swift-version 4.1.2
+```
+
 ## Troubleshooting
 
 #### Swift
@@ -228,6 +241,33 @@ documentation.
 
 Check the `--min-acl` setting -- see [above](#controlling-what-is-documented).
 
+**Unable to find an Xcode with swift version X**
+
+1. The value passed with `--swift-version` must exactly match the version
+   number from `swiftc --version`.  For example Xcode 10.1 needs
+   `--swift-version 4.2.1`.  See [the flag documentation](#choosing-the-swift-language-version).
+2. The Xcode you want to use must be in the Spotlight index.  You can check
+   this using `mdfind 'kMDItemCFBundleIdentifier == com.apple.dt.Xcode'`.
+   Some users have reported this issue being fixed by a reboot; `mdutil -E`
+   may also help.  If none of these work then you can set the `DEVELOPER_DIR`
+   environment variable to point to the Xcode you want before running Jazzy
+   without the `--swift-version` flag.
+
+#### Installation Problems
+
+**Can't find header files / clang**
+
+Some of the Ruby gems that Jazzy depends on have native C extensions.  This
+means you need the Xcode command-line developer tools installed to build
+them: run `xcode-select --install` to install the tools.
+
+**/Applications/Xcode: No such file or directory**
+
+The path of your active Xcode installation must not contain spaces.  So
+`/Applications/Xcode.app/` is fine, `/Applications/Xcode-10.2.app/` is fine,
+but `/Applications/Xcode 10.2.app/` is not.  This restriction applies only
+when *installing* Jazzy, not running it.
+
 ## Development
 
 Please review jazzy's [contributing guidelines](https://github.com/realm/jazzy/blob/master/CONTRIBUTING.md) when submitting pull requests.

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.0'
-  spec.add_runtime_dependency 'mustache', '~> 0.99'
+  spec.add_runtime_dependency 'cocoapods', '~> 1.5.3'
+  spec.add_runtime_dependency 'mustache', '~> 1.1.0'
   spec.add_runtime_dependency 'open4'
-  spec.add_runtime_dependency 'redcarpet', '~> 3.2'
+  spec.add_runtime_dependency 'redcarpet', '~> 3.4.0'
   spec.add_runtime_dependency 'rouge', ['>= 2.0.6', '< 4.0']
-  spec.add_runtime_dependency 'sass', '~> 3.4'
-  spec.add_runtime_dependency 'sqlite3', '~> 1.3'
+  spec.add_runtime_dependency 'sass', '~> 3.6.0'
+  spec.add_runtime_dependency 'sqlite3', '~> 1.3.13'
   spec.add_runtime_dependency 'xcinvoke', '~> 0.3.0'
 
   spec.add_development_dependency 'bundler', '~> 1.7'

data/lib/jazzy/doc_builder.rb

@@ -10,7 +10,6 @@ require 'jazzy/documentation_generator'
 require 'jazzy/search_builder'
 require 'jazzy/jazzy_markdown'
 require 'jazzy/podspec_documenter'
-require 'jazzy/readme_generator'
 require 'jazzy/source_declaration'
 require 'jazzy/source_document'
 require 'jazzy/source_module'
@@ -95,7 +94,7 @@ module Jazzy
 
     def self.each_doc(output_dir, docs, &block)
       docs.each do |doc|
-        next unless doc.render?
+        next unless doc.render_as_page?
         # Assuming URL is relative to documentation root:
         path = output_dir + (doc.url || "#{doc.name}.html")
         block.call(doc, path)
@@ -332,6 +331,7 @@ module Jazzy
     # Build mustache item for a top-level doc
     # @param [Hash] item Parsed doc child item
     # @param [Config] options Build options
+    # rubocop:disable Metrics/MethodLength
     def self.render_item(item, source_module)
       # Combine abstract and discussion into abstract
       abstract = (item.abstract || '') + (item.discussion || '')
@@ -347,11 +347,16 @@ module Jazzy
         from_protocol_extension:    item.from_protocol_extension,
         return:                     item.return,
         parameters:                 (item.parameters if item.parameters.any?),
-        url:                        (item.url if item.children.any?),
+        url:                        (item.url if item.render_as_page?),
         start_line:                 item.start_line,
         end_line:                   item.end_line,
+        direct_link:                item.omit_content_from_parent?,
+        deprecation_message:        item.deprecation_message,
+        unavailable_message:        item.unavailable_message,
+        usage_discouraged:          item.usage_discouraged?,
       }
     end
+    # rubocop:enable Metrics/MethodLength
 
     def self.make_task(mark, uid, items)
       {
@@ -391,7 +396,7 @@ module Jazzy
     # @param [Array] doc_structure doc structure comprised of section names and
     #        child names and URLs. @see doc_structure_for_docs
     def self.document(source_module, doc_model, path_to_root)
-      if doc_model.type.kind == 'document.markdown'
+      if doc_model.type.markdown?
         return document_markdown(source_module, doc_model, path_to_root)
       end
 
@@ -418,6 +423,9 @@ module Jazzy
       doc[:github_url] = source_module.github_url
       doc[:dash_url] = source_module.dash_url
       doc[:path_to_root] = path_to_root
+      doc[:deprecation_message] = doc_model.deprecation_message
+      doc[:unavailable_message] = doc_model.unavailable_message
+      doc[:usage_discouraged] = doc_model.usage_discouraged?
       doc.render.gsub(ELIDED_AUTOLINK_TOKEN, path_to_root)
     end
     # rubocop:enable Metrics/MethodLength

data/lib/jazzy/documentation_generator.rb

@@ -11,15 +11,8 @@ module Jazzy
       documentation_entries.map do |file_path|
         SourceDocument.new.tap do |sd|
           sd.name = File.basename(file_path, '.md')
-          sd.url = sd.name.downcase.strip
-                     .tr(' ', '-').gsub(/[^\w-]/, '') + '.html'
-          sd.type = SourceDeclaration::Type.new 'document.markdown'
-          sd.children = []
           sd.overview = overview Pathname(file_path)
           sd.usr = 'documentation.' + sd.name
-          sd.abstract = ''
-          sd.return = ''
-          sd.parameters = []
         end
       end
     end

data/lib/jazzy/gem_version.rb

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

data/lib/jazzy/podspec_documenter.rb

@@ -27,7 +27,7 @@ module Jazzy
 
           targets.map do |t|
             args = %W[doc --module-name #{podspec.module_name} -- -target #{t}]
-            swift_version = (config.swift_version || '4')[0] + '.0'
+            swift_version = compiler_swift_version(config.swift_version)
             args << "SWIFT_VERSION=#{swift_version}"
             SourceKitten.run_sourcekitten(args)
           end
@@ -97,6 +97,23 @@ module Jazzy
 
     private_class_method :github_file_prefix
 
+    # Latest valid value for SWIFT_VERSION.
+    LATEST_SWIFT_VERSION = '4.2'.freeze
+
+    # All valid values for SWIFT_VERSION that are longer
+    # than a major version number.  Ordered ascending.
+    LONG_SWIFT_VERSIONS = ['4.2'].freeze
+
+    # 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
+
+      LONG_SWIFT_VERSIONS.select do |version|
+        user_version.start_with?(version)
+      end.last || "#{user_version[0]}.0"
+    end
+
     # @!group SourceKitten output helper methods
 
     def pod_path

data/lib/jazzy/source_declaration.rb

@@ -8,12 +8,15 @@ module Jazzy
     # static type of declared element (e.g. String.Type -> ())
     attr_accessor :typename
 
-    def type?(type_kind)
-      respond_to?(:type) && type.kind == type_kind
+    # Give the item its own page or just inline into parent?
+    def render_as_page?
+      children.any?
     end
 
-    def render?
-      type?('document.markdown') || children.count != 0
+    # When referencing this item from its parent category,
+    # include the content or just link to it directly?
+    def omit_content_from_parent?
+      false
     end
 
     # Element containing this declaration in the code
@@ -99,6 +102,14 @@ module Jazzy
     attr_accessor :end_line
     attr_accessor :nav_order
     attr_accessor :url_name
+    attr_accessor :deprecated
+    attr_accessor :deprecation_message
+    attr_accessor :unavailable
+    attr_accessor :unavailable_message
+
+    def usage_discouraged?
+      unavailable || deprecated
+    end
 
     def alternative_abstract
       if file = alternative_abstract_file

data/lib/jazzy/source_declaration/type.rb

@@ -129,6 +129,16 @@ module Jazzy
         Type.new('Overview')
       end
 
+      MARKDOWN_KIND = 'document.markdown'.freeze
+
+      def self.markdown
+        Type.new(MARKDOWN_KIND)
+      end
+
+      def markdown?
+        kind == MARKDOWN_KIND
+      end
+
       def hash
         kind.hash
       end
@@ -140,7 +150,7 @@ module Jazzy
 
       TYPES = {
         # Markdown
-        'document.markdown' => {
+        MARKDOWN_KIND => {
           jazzy: 'Guide',
           dash: 'Guide',
         }.freeze,

data/lib/jazzy/source_document.rb

@@ -3,19 +3,35 @@ require 'pathname'
 require 'jazzy/jazzy_markdown'
 
 module Jazzy
+  # Standalone markdown docs including index.html
   class SourceDocument < SourceDeclaration
     attr_accessor :overview
     attr_accessor :readme_path
 
+    def initialize
+      super
+      self.children = []
+      self.parameters = []
+      self.abstract = ''
+      self.type = SourceDeclaration::Type.markdown
+      self.mark = SourceMark.new
+    end
+
     def self.make_index(readme_path)
       SourceDocument.new.tap do |sd|
         sd.name = 'index'
-        sd.children = []
-        sd.type = SourceDeclaration::Type.new 'document.markdown'
         sd.readme_path = readme_path
       end
     end
 
+    def render_as_page?
+      true
+    end
+
+    def omit_content_from_parent?
+      true
+    end
+
     def config
       Config.instance
     end

data/lib/jazzy/sourcekitten.rb

@@ -322,6 +322,8 @@ module Jazzy
           Highlighter.highlight(make_swift_declaration(doc, declaration))
       end
 
+      make_deprecation_info(doc, declaration)
+
       unless doc['key.doc.full_as_xml']
         return process_undocumented_token(doc, declaration)
       end
@@ -335,6 +337,17 @@ module Jazzy
       @stats.add_documented
     end
 
+    def self.make_deprecation_info(doc, declaration)
+      if declaration.deprecated
+        declaration.deprecation_message =
+          Markdown.render(doc['key.deprecation_message'] || '')
+      end
+      if declaration.unavailable
+        declaration.unavailable_message =
+          Markdown.render(doc['key.unavailable_message'] || '')
+      end
+    end
+
     # Strip tags and convert entities
     def self.xml_to_text(xml)
       document = REXML::Document.new(xml)
@@ -482,6 +495,8 @@ module Jazzy
         declaration.column = doc['key.doc.column']
         declaration.start_line = doc['key.parsed_scope.start']
         declaration.end_line = doc['key.parsed_scope.end']
+        declaration.deprecated = doc['key.always_deprecated']
+        declaration.unavailable = doc['key.always_unavailable']
 
         next unless make_doc_info(doc, declaration)
         make_substructure(doc, declaration)
@@ -742,28 +757,34 @@ module Jazzy
       end
     end
 
+    AUTOLINK_TEXT_FIELDS = %w[return
+                              abstract
+                              unavailable_message
+                              deprecation_message].freeze
+
+    AUTOLINK_HIGHLIGHT_FIELDS = %w[declaration
+                                   other_language_declaration].freeze
+
     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)
+        AUTOLINK_TEXT_FIELDS.each do |field|
+          if text = doc.send(field)
+            doc.send(field + '=', autolink_text(text, doc, root_decls))
+          end
         end
 
-        if doc.declaration
-          doc.declaration = autolink_text(
-            doc.declaration, doc, root_decls, true
-          )
+        AUTOLINK_HIGHLIGHT_FIELDS.each do |field|
+          if text = doc.send(field)
+            doc.send(field + '=', autolink_text(text, doc, root_decls, true))
+          end
         end
 
-        if doc.other_language_declaration
-          doc.other_language_declaration = autolink_text(
-            doc.other_language_declaration, doc, root_decls, true
-          )
+        (doc.parameters || []).each do |param|
+          param[:discussion] =
+            autolink_text(param[:discussion], doc, root_decls)
         end
       end
     end

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

@@ -240,7 +240,7 @@ header {
   margin-left: $content_body_left_offset;
   position: absolute;
   overflow: hidden;
-  padding-bottom: 60px;
+  padding-bottom: 20px;
   top: $content_top_offset;
   width: $content_wrapper_width - $content_body_left_offset;
   p, a, code, em, ul, table, blockquote {
@@ -333,11 +333,14 @@ header {
     background-color: transparent;
     padding: 0;
   }
-  .token {
+  .token, .direct-link {
     padding-left: 3px;
     margin-left: 15px;
     font-size: 11.9px;
   }
+  .discouraged {
+    text-decoration: line-through;
+  }
   .declaration-note {
     font-size: .85em;
     color: rgba(128,128,128,1);
@@ -412,7 +415,7 @@ header {
   }
 }
 
-.aside-warning {
+.aside-warning, .aside-deprecated, .aside-unavailable {
   border-left: $aside_warning_border;
   .aside-title {
     color: $aside_warning_color;
@@ -446,8 +449,9 @@ header {
 }
 
 #footer {
-  position: absolute;
-  bottom: 10px;
+  position: relative;
+  top: 10px;
+  bottom: 0px;
   margin-left: 25px;
   p {
     margin: 0;

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

@@ -0,0 +1,12 @@
+{{#deprecation_message}}
+<div class="aside aside-deprecated">
+  <p class="aside-title">Deprecated</p>
+  {{{deprecation_message}}}
+</div>
+{{/deprecation_message}}
+{{#unavailable_message}}
+<div class="aside aside-unavailable">
+  <p class="aside-title">Unavailable</p>
+  {{{unavailable_message}}}
+</div>
+{{/unavailable_message}}

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

@@ -28,6 +28,7 @@
         <section>
           <section class="section">
             {{^hide_name}}<h1>{{name}}</h1>{{/hide_name}}
+            {{> deprecation}}
             {{#declaration}}
               <div class="declaration">
                 <div class="language">

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

@@ -15,7 +15,17 @@
         <code>
         <a name="/{{usr}}"></a>
         <a name="//apple_ref/{{language_stub}}/{{dash_type}}/{{name}}" class="dashAnchor"></a>
+        {{#direct_link}}
+        <a class="direct-link" href="{{url}}">{{name}}</a>
+        </code>
+        {{/direct_link}}
+        {{^direct_link}}
+        {{^usage_discouraged}}
         <a class="token" href="#/{{usr}}">{{name}}</a>
+        {{/usage_discouraged}}
+        {{#usage_discouraged}}
+        <a class="token discouraged" href="#/{{usr}}">{{name}}</a>
+        {{/usage_discouraged}}
         </code>
         {{#default_impl_abstract}}
           <span class="declaration-note">
@@ -32,6 +42,7 @@
         <div class="pointer-container"></div>
         <section class="section">
           <div class="pointer"></div>
+          {{> deprecation}}
           {{#abstract}}
           <div class="abstract">
             {{{abstract}}}
@@ -85,6 +96,7 @@
           </div>
           {{/github_token_url}}
         </section>
+        {{/direct_link}}
       </div>
     </li>
     {{/items}}

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

@@ -154,8 +154,14 @@ a {
     outline: 0;
     text-decoration: underline;
   }
-}
 
+  &.discouraged {
+    text-decoration: line-through;
+    &:hover, &:focus {
+      text-decoration: underline line-through;
+    }
+  }
+}
 
 // ----- Tables
 
@@ -404,7 +410,7 @@ pre code {
     }
   }
 
-  .token {
+  .token, .direct-link {
     padding-left: 3px;
     margin-left: 0px;
     font-size: 1rem;
@@ -479,7 +485,7 @@ pre code {
   }
 }
 
-.aside-warning {
+.aside-warning, .aside-deprecated, .aside-unavailable {
   border-left: $aside_warning_border;
   .aside-title {
     color: $aside_warning_color;
@@ -612,4 +618,4 @@ form[role=search] {
   .tt-suggestion.tt-cursor .doc-parent-name {
     color: #fff;
   }
-}
+}

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

@@ -2,6 +2,7 @@ $(function(){
   var searchIndex = lunr(function() {
     this.ref('url');
     this.field('name');
+    this.field('abstract');
   });
 
   var $typeahead = $('[data-typeahead]');
@@ -27,7 +28,7 @@ $(function(){
 
     $.getJSON(searchURL).then(function(searchData) {
       $.each(searchData, function (url, doc) {
-        searchIndex.add({url: url, name: doc.name});
+        searchIndex.add({url: url, name: doc.name, abstract: doc.abstract});
       });
 
       $typeahead.typeahead(

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

@@ -0,0 +1,12 @@
+{{#deprecation_message}}
+<div class="aside aside-deprecated">
+  <p class="aside-title">Deprecated</p>
+  {{{deprecation_message}}}
+</div>
+{{/deprecation_message}}
+{{#unavailable_message}}
+<div class="aside aside-unavailable">
+  <p class="aside-title">Unavailable</p>
+  {{{unavailable_message}}}
+</div>
+{{/unavailable_message}}

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

@@ -37,6 +37,7 @@
         <section class="section">
           <div class="section-content">
             {{^hide_name}}<h1>{{name}}</h1>{{/hide_name}}
+            {{> deprecation}}
             {{#declaration}}
               <div class="declaration">
                 <div class="language">

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

@@ -15,7 +15,17 @@
         <code>
         <a name="/{{usr}}"></a>
         <a name="//apple_ref/{{language_stub}}/{{dash_type}}/{{name}}" class="dashAnchor"></a>
+        {{#direct_link}}
+        <a class="direct-link" href="{{url}}">{{name}}</a>
+        </code>
+        {{/direct_link}}
+        {{^direct_link}}
+        {{^usage_discouraged}}
         <a class="token" href="#/{{usr}}">{{name}}</a>
+        {{/usage_discouraged}}
+        {{#usage_discouraged}}
+        <a class="token discouraged" href="#/{{usr}}">{{name}}</a>
+        {{/usage_discouraged}}
         </code>
         {{#default_impl_abstract}}
           <span class="declaration-note">
@@ -32,6 +42,7 @@
         <div class="pointer-container"></div>
         <section class="section">
           <div class="pointer"></div>
+          {{> deprecation}}
           {{#abstract}}
           <div class="abstract">
             {{{abstract}}}
@@ -85,6 +96,7 @@
           </div>
           {{/github_token_url}}
         </section>
+        {{/direct_link}}
       </div>
     </li>
     {{/items}}

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

@@ -372,10 +372,13 @@ header {
     background-color: transparent;
     padding: 0;
   }
-  .token {
+  .token, .direct-link {
     padding-left: 3px;
     margin-left: 35px;
   }
+  .discouraged {
+    text-decoration: line-through;
+  }
   .declaration-note {
     font-size: .85em;
     color: rgba(128,128,128,1);
@@ -448,7 +451,7 @@ header {
   }
 }
 
-.aside-warning {
+.aside-warning, .aside-deprecated, .aside-unavailable {
   border-left: $aside_warning_border;
   .aside-title {
     color: $aside_warning_color;

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

@@ -0,0 +1,12 @@
+{{#deprecation_message}}
+<div class="aside aside-deprecated">
+  <p class="aside-title">Deprecated</p>
+  {{{deprecation_message}}}
+</div>
+{{/deprecation_message}}
+{{#unavailable_message}}
+<div class="aside aside-unavailable">
+  <p class="aside-title">Unavailable</p>
+  {{{unavailable_message}}}
+</div>
+{{/unavailable_message}}

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

@@ -33,6 +33,7 @@
           <section>
             <section class="section">
               {{^hide_name}}<h1>{{name}}</h1>{{/hide_name}}
+              {{> deprecation}}
               {{#declaration}}
                 <div class="declaration">
                   <div class="language">

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

@@ -15,7 +15,17 @@
         <code>
         <a name="/{{usr}}"></a>
         <a name="//apple_ref/{{language_stub}}/{{dash_type}}/{{name}}" class="dashAnchor"></a>
+        {{#direct_link}}
+        <a class="direct-link" href="{{url}}">{{name}}</a>
+        </code>
+        {{/direct_link}}
+        {{^direct_link}}
+        {{^usage_discouraged}}
         <a class="token" href="#/{{usr}}">{{name}}</a>
+        {{/usage_discouraged}}
+        {{#usage_discouraged}}
+        <a class="token discouraged" href="#/{{usr}}">{{name}}</a>
+        {{/usage_discouraged}}
         </code>
         {{#default_impl_abstract}}
           <span class="declaration-note">
@@ -32,6 +42,7 @@
         <div class="pointer-container"></div>
         <section class="section">
           <div class="pointer"></div>
+          {{> deprecation}}
           {{#abstract}}
           <div class="abstract">
             {{{abstract}}}
@@ -85,6 +96,7 @@
           </div>
           {{/github_token_url}}
         </section>
+        {{/direct_link}}
       </div>
     </li>
     {{/items}}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jazzy
 version: !ruby/object:Gem::Version
-  version: 0.9.4
+  version: 0.9.5
 platform: ruby
 authors:
 - JP Simard
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-01 00:00:00.000000000 Z
+date: 2019-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cocoapods
@@ -18,28 +18,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 1.5.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 1.5.3
 - !ruby/object:Gem::Dependency
   name: mustache
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.99'
+        version: 1.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.99'
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: open4
   requirement: !ruby/object:Gem::Requirement
@@ -60,14 +60,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: 3.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: 3.4.0
 - !ruby/object:Gem::Dependency
   name: rouge
   requirement: !ruby/object:Gem::Requirement
@@ -94,28 +94,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: 3.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: 3.6.0
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 1.3.13
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 1.3.13
 - !ruby/object:Gem::Dependency
   name: xcinvoke
   requirement: !ruby/object:Gem::Requirement
@@ -198,7 +198,6 @@ files:
 - lib/jazzy/highlighter.rb
 - lib/jazzy/jazzy_markdown.rb
 - lib/jazzy/podspec_documenter.rb
-- lib/jazzy/readme_generator.rb
 - lib/jazzy/search_builder.rb
 - lib/jazzy/source_declaration.rb
 - lib/jazzy/source_declaration/access_control_level.rb
@@ -215,6 +214,7 @@ files:
 - lib/jazzy/themes/apple/assets/img/gh.png
 - lib/jazzy/themes/apple/assets/js/jazzy.js
 - lib/jazzy/themes/apple/assets/js/jquery.min.js
+- lib/jazzy/themes/apple/templates/deprecation.mustache
 - lib/jazzy/themes/apple/templates/doc.mustache
 - lib/jazzy/themes/apple/templates/footer.mustache
 - lib/jazzy/themes/apple/templates/header.mustache
@@ -233,6 +233,7 @@ files:
 - lib/jazzy/themes/fullwidth/assets/js/jquery.min.js
 - lib/jazzy/themes/fullwidth/assets/js/lunr.min.js
 - lib/jazzy/themes/fullwidth/assets/js/typeahead.jquery.js
+- lib/jazzy/themes/fullwidth/templates/deprecation.mustache
 - lib/jazzy/themes/fullwidth/templates/doc.mustache
 - lib/jazzy/themes/fullwidth/templates/footer.mustache
 - lib/jazzy/themes/fullwidth/templates/header.mustache
@@ -247,6 +248,7 @@ files:
 - lib/jazzy/themes/jony/assets/img/gh.png
 - lib/jazzy/themes/jony/assets/js/jazzy.js
 - lib/jazzy/themes/jony/assets/js/jquery.min.js
+- lib/jazzy/themes/jony/templates/deprecation.mustache
 - lib/jazzy/themes/jony/templates/doc.mustache
 - lib/jazzy/themes/jony/templates/footer.mustache
 - lib/jazzy/themes/jony/templates/header.mustache
@@ -278,7 +280,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14.3
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Soulful docs for Swift & Objective-C.

data/lib/jazzy/readme_generator.rb

@@ -1,61 +0,0 @@
-require 'pathname'
-
-require 'jazzy/jazzy_markdown'
-
-module Jazzy
-  module ReadmeGenerator
-    extend Config::Mixin
-
-    def self.generate(source_module)
-      readme = readme_path
-
-      unless readme && readme.exist? && readme = readme.read
-        readme = generated_readme(source_module)
-      end
-
-      Jazzy.markdown.render(readme)
-    end
-
-    def self.readme_path
-      return config.readme_path if config.readme_path
-      %w[README.md README.markdown README.mdown README].each do |potential_name|
-        file = config.source_directory + potential_name
-        return file if file.exist?
-      end
-      nil
-    end
-
-    def self.generated_readme(source_module)
-      if podspec = config.podspec
-        ### License
-
-        # <a href="#{license[:url]}">#{license[:license]}</a>
-        <<-EOS
-# #{podspec.name}
-
-### #{podspec.summary}
-
-#{podspec.description}
-
-### Installation
-
-```ruby
-pod '#{podspec.name}'
-```
-
-### Authors
-
-#{source_module.author_name}
-EOS
-      else
-        <<-EOS
-# #{source_module.name}
-
-### Authors
-
-#{source_module.author_name}
-EOS
-      end
-    end
-  end
-end