The fullwidth
theme now comes with search functionality! Big thanks to our friends at PSPDFKit and Mapbox for contributing to this!
Lots of other great enhancements and bug fixes. Enjoy! 🥃
Breaking
- None.
Enhancements
- Generate shields.io badge for documentation coverage, unless
hide_documentation_coverage
is set.
Harlan Haskins
#723 - Add support for searching docs when using the
fullwidth
theme. A new option,
--disable-search
, lets you turn this off.
Esad Hajdarevic
Tom MacWright
Nadia Barbosa
#14 - New config option
use_safe_filenames
encodes unsafe characters when
generating filenames. By default, documentation may receive filenames like
/(_:_:).html
. Withuse_safe_filenames
, the same file will receive the name
_2F_28_5F_3A_5F_3A_29.html
instead.
Jeremy David Giesbrecht
#699
#146
#361
#547 - References to Objective-C methods are now autolinked.
Minh Nguyễn
#362 - Print documentation coverage percentage and the number of undocumented
methods to the command line when running jazzy.
Jason Wray
Bug Fixes
- Fix issue where existing abstracts for non custom sections would be completely
overwritten when using extra abstract injection with --abstract.
Thibaud Robelain
#600 - Fix issue where generic type parameters registered as undocumented symbols.
Jeremy David Giesbrecht
#429 - Fix issue where parameter and return callouts were duplicated in documentation.
Jeremy David Giesbrecht
#673 - Fix issue where Objective-C superclass in declaration was unlinked.
Minh Nguyễn
#706 - Fix issue where multiple Objective-C categories of the same external class
in different files were merged into one and named after the first category
found.
Minh Nguyễn
#539 - String literals in code listings are no longer wrapped in
<q>
tags (apple
andfullwidth
themes only).
Minh Nguyễn
#714 - Fix issue where passing a
--podspec
argument would use a malformed
SWIFT_VERSION
value, causing compilation to fail.
JP Simard