Releases: realm/jazzy
0.15.0
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-filemodules
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
- Fix incorrect activesupport usage.
John Fairhurst
0.14.4
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
-
Issue a warning instead of crashing on declarations without names.
#1325
John Fairhurst -
Fix extension ordering in symbolgraph mode.
John Fairhurst -
Fix symbolgraph mode crash involving tuple generic constraints.
John Fairhurst
0.14.3
Breaking
- None.
Enhancements
-
Support Swift 5.7 and Xcode 14.
John Fairhurst -
Update Javascript: jQuery 3.6.1, KaTeX 0.13.5
John Fairhurst
Bug Fixes
- None.
0.14.2
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
Breaking
- Support Swift SPI groups. Swift declarations marked
@_spi
are no longer included in docs when--min-acl
is set topublic
oropen
. Use--include-spi-declarations
to include docs for these declarations.
John Fairhurst
#1263
Enhancements
-
Correct line number references with Xcode 13.
John Fairhurst -
Support
union
declarations in Objective-C headers.
Brian Osborn
John Fairhurst -
Support Swift concurrency features: identify actors and asynchronous methods.
John Fairhurst
Bug Fixes
- Improve HTML5 correctness, all themes.
John Fairhurst
#1280
0.14.0
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 alltarget="_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
0.13.7
The next release of Jazzy will require a minimum of Ruby 2.6.
Breaking
- None.
Enhancements
-
Update JavaScript libraries: jQuery 3.6.0, Lunr 2.3.9, KaTeX 0.13.5.
John Fairhurst -
Support the markdown footnotes extension in all themes.
John Fairhurst
#1246
Bug Fixes
- Fix parameter doc comments in Swift symbolgraph mode.
John Fairhurst
#1244
0.13.6
Breaking
- None.
Enhancements
- Support documentation generation from
.swiftmodule
binaries using
--swift-build-tool symbolgraph
with Swift 5.3.
John Fairhurst
Bug Fixes
- Always bypass codesigning when building Xcode projects.
John Fairhurst
#1183
0.13.5
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
- Style fixes for
apple
andjony
themes to codeblocks inside lists and links.
John Fairhurst
#818
#1177
0.13.4
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
-
Fix warnings from Ruby 2.7.
John Fairhurst
#1185 -
Accept
root_url
without trailing slash.
John Fairhurst
#1188