jazzy 0.11.0 → 0.13.1

data/lib/jazzy/stats.rb

@@ -18,6 +18,10 @@ module Jazzy
       @undocumented_decls << decl
     end
 
+    def remove_undocumented(decl)
+      @undocumented_decls.delete(decl)
+    end
+
     def acl_included
       documented + undocumented
     end

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

@@ -152,7 +152,7 @@ header {
   background-color: $bg_color;
   position: fixed;
   width: 100%;
-  z-index: 1;
+  z-index: 2;
   img {
     padding-right: 6px;
     vertical-align: -4px;
@@ -177,7 +177,7 @@ header {
   padding-top: $breadcrumb_padding_top;
   position: fixed;
   width: 100%;
-  z-index: 1;
+  z-index: 2;
   margin-top: $header_height;
   #carat {
     height: 10px;
@@ -270,6 +270,17 @@ header {
       margin: -$content_top_offset 0 0;
     }
   }
+  .section-name {
+    p {
+       margin-bottom: inherit;
+       line-height: inherit;
+    }
+    code {
+      background-color: inherit;
+      padding: inherit;
+      color: inherit;
+    }
+  }
 }
 
 .section {
@@ -317,6 +328,29 @@ header {
   }
 }
 
+.section-name-container {
+  position: relative;
+  display: inline-block;
+
+  .section-name-link {
+    position: absolute;
+    top: 0;
+    left: 0;
+    bottom: 0;
+    right: 0;
+    margin-bottom: 0;
+  }
+
+  .section-name {
+    position: relative;
+    pointer-events: none;
+    z-index: 1;
+    a {
+      pointer-events: auto;
+    }
+  }
+}
+
 .item {
   padding-top: 8px;
   width: 100%;

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

@@ -3,9 +3,10 @@
   <div class="task-name-container">
     <a name="/{{uid}}"></a>
     <a name="//apple_ref/{{language_stub}}/Section/{{name}}" class="dashAnchor"></a>
-    <a href="#/{{uid}}">
-      <h3 class="section-name">{{name}}</h3>
-    </a>
+    <div class="section-name-container">
+      <a class="section-name-link" href="#/{{uid}}"></a>
+      <h3 class="section-name">{{{name_html}}}</h3>
+    </div>
   </div>
   {{/name}}
   <ul>

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

@@ -201,13 +201,15 @@ code {
   font-family: $code_font;
 }
 
-p, li {
-  > code {
-    background: $code_bg_color;
-    padding: .2em;
-    &:before, &:after {
-      letter-spacing: -.2em;
-      content: "\00a0";
+.item-container, .top-matter {
+  p, li {
+    > code {
+      background: $code_bg_color;
+      padding: .2em;
+      &:before, &:after {
+        letter-spacing: -.2em;
+        content: "\00a0";
+      }
     }
   }
 }
@@ -367,6 +369,10 @@ pre code {
 .section-name {
   color: #666;
   display: block;
+
+  p {
+    margin-bottom: inherit;
+  }
 }
 
 .declaration .highlight {
@@ -394,6 +400,28 @@ pre code {
   }
 }
 
+.section-name-container {
+  position: relative;
+
+  .section-name-link {
+    position: absolute;
+    top: 0;
+    left: 0;
+    bottom: 0;
+    right: 0;
+    margin-bottom: 0;
+  }
+
+  .section-name {
+    position: relative;
+    pointer-events: none;
+    z-index: 1;
+    a {
+      pointer-events: auto;
+    }
+  }
+}
+
 .item-container {
   padding: 0;
 }

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

@@ -35,7 +35,7 @@
       <article class="main-content">
 
         <section class="section">
-          <div class="section-content">
+          <div class="section-content top-matter">
             {{^hide_name}}<h1>{{name}}</h1>{{/hide_name}}
             {{> deprecation}}
             {{#declaration}}

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

@@ -3,9 +3,10 @@
   <div class="task-name-container">
     <a name="/{{uid}}"></a>
     <a name="//apple_ref/{{language_stub}}/Section/{{name}}" class="dashAnchor"></a>
-    <a href="#/{{uid}}">
-      <h3 class="section-name">{{name}}</h3>
-    </a>
+    <div class="section-name-container">
+      <a class="section-name-link" href="#/{{uid}}"></a>
+      <h3 class="section-name">{{{name_html}}}</h3>
+    </div>
   </div>
   {{/name}}
   <ul class="item-container">

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

@@ -182,7 +182,7 @@ header {
   background-color: $bg_color;
   position: fixed;
   width: 100%;
-  z-index: 2;
+  z-index: 3;
   img {
     padding-right: 6px;
     vertical-align: -4px;
@@ -204,7 +204,7 @@ header {
 #breadcrumbs-container {
   background-color: $bg_color;
   position: fixed;
-  z-index: 1;
+  z-index: 2;
   width: 100%;
 }
 
@@ -310,6 +310,16 @@ header {
       margin: -$content_top_offset 0 0;
     }
   }
+
+  .section-name {
+    p {
+       margin-bottom: inherit;
+       line-height: inherit;
+    }
+    code {
+      color: inherit;
+    }
+  }
 }
 
 .highlight {
@@ -356,6 +366,29 @@ header {
   }
 }
 
+.section-name-container {
+  position: relative;
+  display: inline-block;
+
+  .section-name-link {
+    position: absolute;
+    top: 0;
+    left: 0;
+    bottom: 0;
+    right: 0;
+    margin-bottom: 0;
+  }
+
+  .section-name {
+    position: relative;
+    pointer-events: none;
+    z-index: 1;
+    a {
+      pointer-events: auto;
+    }
+  }
+}
+
 .item {
   padding-top: 8px;
   width: 100%;

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

@@ -3,9 +3,10 @@
   <div class="task-name-container">
     <a name="/{{uid}}"></a>
     <a name="//apple_ref/{{language_stub}}/Section/{{name}}" class="dashAnchor"></a>
-    <a href="#/{{uid}}">
-      <h3 class="section-name">{{name}}</h3>
-    </a>
+    <div class="section-name-container">
+      <a class="section-name-link" href="#/{{uid}}"></a>
+      <h3 class="section-name">{{{name_html}}}</h3>
+    </div>
   </div>
   {{/name}}
   <ul>

data/spec/integration_spec.rb

@@ -52,13 +52,9 @@ require 'cocoapods'
 
 def configure_cocoapods
   Pod::Config.instance.with_changes(silent: true) do
-    config = Pod::Config.instance
-    # working around a bug where `pod setup --silent` isn't silent
-    if config.sources_manager.master_repo_functional?
-      Pod::Command::Repo::Update.invoke(%w[master])
-    else
-      Pod::Command::Setup.invoke
-    end
+    Pod::Command::Setup.invoke
+    Pod::Command::Repo::AddCDN.invoke(%w[trunk https://cdn.cocoapods.org/])
+    Pod::Command::Repo::Update.invoke(%w[trunk])
   end
 end
 
@@ -77,8 +73,11 @@ CLIntegracon.configure do |c|
     File.write(
       path,
       File.read(path).gsub(
-        (ROOT + 'tmp').to_s,
+        c.temp_path.to_s,
         '<TMP>',
+      ).gsub(
+        c.spec_path.to_s,
+        '<SPEC>',
       ),
     )
   end
@@ -164,9 +163,23 @@ describe_cli 'jazzy' do
                             "--head #{realm_head.shellescape}"
     end
 
-    describe 'Creates docs for ObjC project with a variety of contents' do
+    describe 'Creates docs for ObjC-Swift project with a variety of contents' do
+      base = ROOT + 'spec/integration_specs/misc_jazzy_objc_features/before'
+      Dir.chdir(base) do
+        sourcekitten = ROOT + 'bin/sourcekitten'
+        sdk = `xcrun --show-sdk-path --sdk iphonesimulator`.chomp
+        objc_args = "#{base}/MiscJazzyObjCFeatures/MiscJazzyObjCFeatures.h " \
+                    '-- -x objective-c ' \
+                    "-isysroot #{sdk} " \
+                    "-I #{base} " \
+                    '-fmodules'
+        `#{sourcekitten} doc --objc #{objc_args} > objc.json`
+        `#{sourcekitten} doc > swift.json`
+      end
+
       behaves_like cli_spec 'misc_jazzy_objc_features',
-                            '--theme fullwidth'
+                            '--theme fullwidth '\
+                            '-s objc.json,swift.json'
     end
   end if !spec_subset || spec_subset == 'objc'
 

metadata

@@ -1,16 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: jazzy
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.13.1
 platform: ruby
 authors:
 - JP Simard
 - Tim Anglade
 - Samuel Giddins
+- John Fairhurst
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-13 00:00:00.000000000 Z
+date: 2020-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cocoapods
@@ -161,7 +162,7 @@ dependencies:
 description: Soulful docs for Swift & Objective-C. Run in your Xcode project's root
   directory for instant HTML docs.
 email:
-- jp@realm.io
+- jp@jpsim.com
 executables:
 - jazzy
 extensions: []
@@ -279,7 +280,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Soulful docs for Swift & Objective-C.