Jazzy Versions Save

Soulful docs for Swift & Objective-C

v0.14.4

7 months ago
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

v0.14.3

1 year ago
Breaking
  • None.
Enhancements
Bug Fixes
  • None.

v0.14.2

2 years ago
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

v0.14.1

2 years ago
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

v0.14.0

2 years ago
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

v0.13.7

2 years ago

0.13.7

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

Breaking
  • None.
Enhancements
Bug Fixes

v0.13.6

3 years ago
Breaking
  • None.
Enhancements
  • Support documentation generation from .swiftmodule binaries using --swift-build-tool symbolgraph with Swift 5.3. John Fairhurst
Bug Fixes

v0.13.5

3 years ago
Breaking
  • None.
Enhancements
  • Add search function to apple theme. Giles Payne #726

  • Add option --[no-]separate-global-declarations to always create separate documentation pages for top-level declarations as well as classes, structures, enums etc. even if they don't have members. As part of this, improve the main page declaration in all modes. Nikolay Volosatov John Fairhurst

Bug Fixes

v0.13.4

3 years ago
Breaking
  • None.
Enhancements
  • Update JavaScript libraries: jQuery 3.5.1 (all themes), Lunr 2.3.8, typeahead.js 1.3.1 (fullwidth theme only). John Fairhurst
Bug Fixes

v0.13.3

4 years ago
Breaking
  • None.
Enhancements
  • Added a config option to provide sources of privately hosted pod dependencies when using the --podspec option. --pod-sources url1,url2,…urlN. Jonathan Bailey #650

  • Improve Dash docset support: support online redirection when --root-url is set, and provide --docset-playground-url to support docset playground links. John Fairhurst

Bug Fixes