Releases: realm/jazzy
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
0.13.3
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
-
Fix module version not being used from podspec.
Jonathan Bailey -
Autolink Swift custom attributes/property wrappers.
John Fairhurst
0.13.2
Breaking
- None.
Enhancements
-
Support Xcode 11.4. Default Objective-C property attributes are now
stripped from declarations: turn this off with
--keep-default-property-attributes
.
John Fairhurst
#829 -
Render LaTeX expressions written using
$equation$
or$$equation$$
syntax.
Arthur Guiot
John Fairhurst
#1156 -
Wrap long method names on category pages. Use
name_html
in custom
mustache templates to take advantage of this.
John Fairhurst
#995 -
Support Dash-style
apple_ref
links to specific API items, for more
stable and human-readable links from external docs.
Paul Cantrell
#1167
Bug Fixes
-
Don't generate documentation if the
xcodebuild
command fails.
John Fairhurst
jpsim/SourceKitten#643 -
Use multi-line parsed declarations in more places including protocol
methods and typealiases.
John Fairhurst
#896
0.13.1
Breaking
- None.
Enhancements
-
Allow inline html tags in ObjC doc comments.
Chris Williams
#976 -
Support code formatting in ObjC doc comments with
@c
,@code
and
@endcode
.
Bryce Pauken
jpsim/SourceKitten#631 -
Add
custom_categories_unlisted_prefix
configuration setting. This
is the prefix for navigation section names that aren't explicitly
listed incustom_categories
. Defaults to 'Other '.
JP Simard -
Add
hide_unlisted_documentation
configuration setting. Setting this
totrue
hides documentation entries in the sidebar from the
documentation
config value that aren't explicitly listed in
custom_categories
.
JP Simard
Bug Fixes
-
Fix crash when SourceKit returns out of bounds string byte offsets.
JP Simard -
Pick the right version of declarations with type attributes.
John Fairhurst
#1148
0.13.0
Breaking
- None.
Enhancements
-
Add section headings for members added by Swift conditional conformances.
John Fairhurst
#717 -
Parse markdown in MARK comments, make the html available to themes via
name_html
mustache tag key for section headings.
John Fairhurst -
Include protocol conformances added by extensions in Swift docs.
John Fairhurst
Bug Fixes
-
Render bullet lists correctly when followed by a callout.
John Fairhurst
#785 -
Render markup of text inside double quotes.
John Fairhurst
#992 -
Fix
sourcekitten_sourcefile
used from config file.
John Fairhurst
#1137
0.12.0
Breaking
- None.
Enhancements
- Support for mixed Swift-ObjC modules: generate two sets of SourceKitten
json and pass them on using--sourcekitten-sourcefile
.
Joe Susnick
John Fairhurst
#447
Bug Fixes
-
Stop displaying type attributes on extension declarations.
John Fairhurst -
Show ObjC and Swift classes (etc.) in the same category.
John Fairhurst -
Merge Swift extensions into ObjC classes.
John Fairhurst
Joe Susnick
0.11.2
Breaking
- None.
Enhancements
- None.
Bug Fixes
-
Generate Swift docs with Xcode 11 and paths with spaces.
John Fairhurst
#1108 -
Reinstate guessing of module name from podspec, broken in 0.11.0.
John Fairhurst
#1109