Skip to content

Releases: realm/jazzy

0.15.3

19 Oct 11:37
71a492a
Compare
Choose a tag to compare
Breaking
  • None.
Enhancements
  • None.
Bug Fixes
  • Don't crash in SourceKitten when the Swift 6 compiler reports
    educational notes.
    John Fairhurst
    #1399

0.15.2

20 Sep 10:42
7ad05e7
Compare
Choose a tag to compare
Breaking
  • None.
Enhancements
Bug Fixes
  • None.

0.15.1

08 Jun 10:10
Compare
Choose a tag to compare
Breaking
  • None.
Enhancements
  • None.
Bug Fixes

0.15.0

04 May 17:37
93fa9c3
Compare
Choose a tag to compare
Breaking
  • None.
Enhancements
  • Update Javascript: typeahead.js 1.3.4, KaTeX 0.16.10
    John Fairhurst

  • Support Swift 5.10 with Swift Package Manager projects.
    John Fairhurst
    #1381

  • Support documentation of multiple modules in a single website. Use --modules or the config-file modules for more control. See the README 'Documenting multiple modules' for more details.
    Argjira Mala
    Pedro Alcobia
    John Fairhurst
    #564

  • Improve page breadcrumbs to include parent pages and indicate source module of extensions from other modules.
    John Fairhurst

  • Add --readme-title and --docset-title to set the titles of the readme docs page and the Dash docset independently of the module name.
    John Fairhurst

  • Support Swift 5.9 symbolgraph extension symbols.
    John Fairhurst
    #1368

Bug Fixes

0.14.4

18 Sep 12:30
1e8122d
Compare
Choose a tag to compare
Breaking
  • None.
Enhancements
  • Update Javascript: jQuery 3.7.1, KaTeX 0.16.8
    John Fairhurst

  • Support Swift package access control level.
    John Fairhurst

  • Initial support for Swift macro declarations. Requires
    --swift-build-tool symbolgraph.
    John Fairhurst

  • Support Swift @_documentation(visibility:) attribute. Requires
    --swift-build-tool spm|xcodebuild.
    John Fairhurst

Bug Fixes

0.14.3

11 Sep 18:14
b6b49ea
Compare
Choose a tag to compare
Breaking
  • None.
Enhancements
Bug Fixes
  • None.

0.14.2

17 Mar 10:24
73829b1
Compare
Choose a tag to compare
Breaking
  • When building with Swift 5.6 and not passing —-module to Jazzy, declarations may not be correctly identified as undocumented and docs may include unwanted extensions. Pass —-module MyModuleName to fix this.
    John Fairhurst
Enhancements
  • Support using pre-generated symbolgraph files in Swift symbolgraph mode.
    Nathan Wong

  • Issue a warning on some combinations of Objective-C flags.
    John Fairhurst
    #900

  • Support Swift 5.6. The bundled sourcekitten is a universal binary.
    John Fairhurst

Bug Fixes
  • In Swift symbolgraph mode, stop including extensions to types that are beneath the minimum ACL.
    John Fairhurst
    #1291

0.14.1

04 Oct 11:34
2c308bd
Compare
Choose a tag to compare
Breaking
  • Support Swift SPI groups. Swift declarations marked @_spi are no longer included in docs when --min-acl is set to public or open. Use --include-spi-declarations to include docs for these declarations.
    John Fairhurst
    #1263
Enhancements
Bug Fixes

0.14.0

14 Aug 16:24
6df391c
Compare
Choose a tag to compare
Breaking
  • Require at least Ruby 2.6.3.
Enhancements
  • Support DocC-style autolinks and callouts in markdown.
    John Fairhurst

  • Add --source-host option to support projects hosted on GitLab and Bitbucket as well as GitHub. Options --source-host-url and --source-host-files-url and new Mustache tags replace the 'github' versions which remain as back-compatibility aliases.
    John Fairhurst
    #314

  • Add rel="noopener" to all target="_blank" links.
    JP Simard

Bug Fixes
  • Fix source-host line number references in Swift symbolgraph mode, and
    in ObjC mode for references to one-line declarations.
    John Fairhurst

  • Fix crash with ` ` in markdown.
    John Fairhurst
    #1270

  • Fix symbolgraph mode with Xcode 13.
    John Fairhurst

0.13.7

06 May 08:48
d5bcd69
Compare
Choose a tag to compare

0.13.7

The next release of Jazzy will require a minimum of Ruby 2.6.

Breaking
  • None.
Enhancements
Bug Fixes