jazzy 0.14.4 → 0.15.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
 - data/.github/workflows/Tests.yml +6 -5
 - data/.rubocop.yml +19 -0
 - data/CHANGELOG.md +56 -0
 - data/CONTRIBUTING.md +1 -1
 - data/Gemfile.lock +66 -49
 - data/README.md +115 -5
 - data/bin/sourcekitten +0 -0
 - data/jazzy.gemspec +1 -1
 - data/js/package-lock.json +6 -6
 - data/lib/jazzy/config.rb +156 -24
 - data/lib/jazzy/doc.rb +2 -2
 - data/lib/jazzy/doc_builder.rb +55 -29
 - data/lib/jazzy/doc_index.rb +185 -0
 - data/lib/jazzy/docset_builder/info_plist.mustache +1 -1
 - data/lib/jazzy/docset_builder.rb +44 -13
 - data/lib/jazzy/extensions/katex/css/katex.min.css +1 -1
 - data/lib/jazzy/extensions/katex/js/katex.min.js +1 -1
 - data/lib/jazzy/gem_version.rb +1 -1
 - data/lib/jazzy/grouper.rb +130 -0
 - data/lib/jazzy/podspec_documenter.rb +1 -1
 - data/lib/jazzy/source_declaration/type.rb +10 -2
 - data/lib/jazzy/source_declaration.rb +69 -8
 - data/lib/jazzy/source_document.rb +5 -1
 - data/lib/jazzy/source_module.rb +13 -11
 - data/lib/jazzy/sourcekitten.rb +232 -236
 - data/lib/jazzy/symbol_graph/ext_key.rb +37 -0
 - data/lib/jazzy/symbol_graph/ext_node.rb +23 -6
 - data/lib/jazzy/symbol_graph/graph.rb +31 -19
 - data/lib/jazzy/symbol_graph/relationship.rb +21 -3
 - data/lib/jazzy/symbol_graph/sym_node.rb +10 -22
 - data/lib/jazzy/symbol_graph/symbol.rb +28 -0
 - data/lib/jazzy/symbol_graph.rb +19 -16
 - data/lib/jazzy/themes/apple/assets/css/jazzy.css.scss +10 -7
 - data/lib/jazzy/themes/apple/assets/js/typeahead.jquery.js +3 -2
 - data/lib/jazzy/themes/apple/templates/doc.mustache +8 -1
 - data/lib/jazzy/themes/fullwidth/assets/css/jazzy.css.scss +5 -5
 - data/lib/jazzy/themes/fullwidth/assets/js/typeahead.jquery.js +3 -2
 - data/lib/jazzy/themes/fullwidth/templates/doc.mustache +8 -1
 - data/lib/jazzy/themes/jony/assets/css/jazzy.css.scss +6 -5
 - data/lib/jazzy/themes/jony/templates/doc.mustache +9 -2
 - data/spec/integration_spec.rb +8 -1
 - metadata +16 -7
 
    
        metadata
    CHANGED
    
    | 
         @@ -1,7 +1,7 @@ 
     | 
|
| 
       1 
1 
     | 
    
         
             
            --- !ruby/object:Gem::Specification
         
     | 
| 
       2 
2 
     | 
    
         
             
            name: jazzy
         
     | 
| 
       3 
3 
     | 
    
         
             
            version: !ruby/object:Gem::Version
         
     | 
| 
       4 
     | 
    
         
            -
              version: 0. 
     | 
| 
      
 4 
     | 
    
         
            +
              version: 0.15.1
         
     | 
| 
       5 
5 
     | 
    
         
             
            platform: ruby
         
     | 
| 
       6 
6 
     | 
    
         
             
            authors:
         
     | 
| 
       7 
7 
     | 
    
         
             
            - JP Simard
         
     | 
| 
         @@ -11,7 +11,7 @@ authors: 
     | 
|
| 
       11 
11 
     | 
    
         
             
            autorequire:
         
     | 
| 
       12 
12 
     | 
    
         
             
            bindir: bin
         
     | 
| 
       13 
13 
     | 
    
         
             
            cert_chain: []
         
     | 
| 
       14 
     | 
    
         
            -
            date:  
     | 
| 
      
 14 
     | 
    
         
            +
            date: 2024-06-08 00:00:00.000000000 Z
         
     | 
| 
       15 
15 
     | 
    
         
             
            dependencies:
         
     | 
| 
       16 
16 
     | 
    
         
             
            - !ruby/object:Gem::Dependency
         
     | 
| 
       17 
17 
     | 
    
         
             
              name: cocoapods
         
     | 
| 
         @@ -73,16 +73,22 @@ dependencies: 
     | 
|
| 
       73 
73 
     | 
    
         
             
              name: rexml
         
     | 
| 
       74 
74 
     | 
    
         
             
              requirement: !ruby/object:Gem::Requirement
         
     | 
| 
       75 
75 
     | 
    
         
             
                requirements:
         
     | 
| 
       76 
     | 
    
         
            -
                - - " 
     | 
| 
      
 76 
     | 
    
         
            +
                - - ">="
         
     | 
| 
      
 77 
     | 
    
         
            +
                  - !ruby/object:Gem::Version
         
     | 
| 
      
 78 
     | 
    
         
            +
                    version: 3.2.7
         
     | 
| 
      
 79 
     | 
    
         
            +
                - - "<"
         
     | 
| 
       77 
80 
     | 
    
         
             
                  - !ruby/object:Gem::Version
         
     | 
| 
       78 
     | 
    
         
            -
                    version: ' 
     | 
| 
      
 81 
     | 
    
         
            +
                    version: '4.0'
         
     | 
| 
       79 
82 
     | 
    
         
             
              type: :runtime
         
     | 
| 
       80 
83 
     | 
    
         
             
              prerelease: false
         
     | 
| 
       81 
84 
     | 
    
         
             
              version_requirements: !ruby/object:Gem::Requirement
         
     | 
| 
       82 
85 
     | 
    
         
             
                requirements:
         
     | 
| 
       83 
     | 
    
         
            -
                - - " 
     | 
| 
      
 86 
     | 
    
         
            +
                - - ">="
         
     | 
| 
      
 87 
     | 
    
         
            +
                  - !ruby/object:Gem::Version
         
     | 
| 
      
 88 
     | 
    
         
            +
                    version: 3.2.7
         
     | 
| 
      
 89 
     | 
    
         
            +
                - - "<"
         
     | 
| 
       84 
90 
     | 
    
         
             
                  - !ruby/object:Gem::Version
         
     | 
| 
       85 
     | 
    
         
            -
                    version: ' 
     | 
| 
      
 91 
     | 
    
         
            +
                    version: '4.0'
         
     | 
| 
       86 
92 
     | 
    
         
             
            - !ruby/object:Gem::Dependency
         
     | 
| 
       87 
93 
     | 
    
         
             
              name: rouge
         
     | 
| 
       88 
94 
     | 
    
         
             
              requirement: !ruby/object:Gem::Requirement
         
     | 
| 
         @@ -209,6 +215,7 @@ files: 
     | 
|
| 
       209 
215 
     | 
    
         
             
            - lib/jazzy/config.rb
         
     | 
| 
       210 
216 
     | 
    
         
             
            - lib/jazzy/doc.rb
         
     | 
| 
       211 
217 
     | 
    
         
             
            - lib/jazzy/doc_builder.rb
         
     | 
| 
      
 218 
     | 
    
         
            +
            - lib/jazzy/doc_index.rb
         
     | 
| 
       212 
219 
     | 
    
         
             
            - lib/jazzy/docset_builder.rb
         
     | 
| 
       213 
220 
     | 
    
         
             
            - lib/jazzy/docset_builder/info_plist.mustache
         
     | 
| 
       214 
221 
     | 
    
         
             
            - lib/jazzy/documentation_generator.rb
         
     | 
| 
         @@ -279,6 +286,7 @@ files: 
     | 
|
| 
       279 
286 
     | 
    
         
             
            - lib/jazzy/extensions/katex/css/katex.min.css
         
     | 
| 
       280 
287 
     | 
    
         
             
            - lib/jazzy/extensions/katex/js/katex.min.js
         
     | 
| 
       281 
288 
     | 
    
         
             
            - lib/jazzy/gem_version.rb
         
     | 
| 
      
 289 
     | 
    
         
            +
            - lib/jazzy/grouper.rb
         
     | 
| 
       282 
290 
     | 
    
         
             
            - lib/jazzy/highlighter.rb
         
     | 
| 
       283 
291 
     | 
    
         
             
            - lib/jazzy/jazzy_markdown.rb
         
     | 
| 
       284 
292 
     | 
    
         
             
            - lib/jazzy/podspec_documenter.rb
         
     | 
| 
         @@ -294,6 +302,7 @@ files: 
     | 
|
| 
       294 
302 
     | 
    
         
             
            - lib/jazzy/stats.rb
         
     | 
| 
       295 
303 
     | 
    
         
             
            - lib/jazzy/symbol_graph.rb
         
     | 
| 
       296 
304 
     | 
    
         
             
            - lib/jazzy/symbol_graph/constraint.rb
         
     | 
| 
      
 305 
     | 
    
         
            +
            - lib/jazzy/symbol_graph/ext_key.rb
         
     | 
| 
       297 
306 
     | 
    
         
             
            - lib/jazzy/symbol_graph/ext_node.rb
         
     | 
| 
       298 
307 
     | 
    
         
             
            - lib/jazzy/symbol_graph/graph.rb
         
     | 
| 
       299 
308 
     | 
    
         
             
            - lib/jazzy/symbol_graph/relationship.rb
         
     | 
| 
         @@ -373,7 +382,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement 
     | 
|
| 
       373 
382 
     | 
    
         
             
                - !ruby/object:Gem::Version
         
     | 
| 
       374 
383 
     | 
    
         
             
                  version: '0'
         
     | 
| 
       375 
384 
     | 
    
         
             
            requirements: []
         
     | 
| 
       376 
     | 
    
         
            -
            rubygems_version: 3. 
     | 
| 
      
 385 
     | 
    
         
            +
            rubygems_version: 3.5.3
         
     | 
| 
       377 
386 
     | 
    
         
             
            signing_key:
         
     | 
| 
       378 
387 
     | 
    
         
             
            specification_version: 4
         
     | 
| 
       379 
388 
     | 
    
         
             
            summary: Soulful docs for Swift & Objective-C.
         
     |