Skip to content

Releases: realm/jazzy

0.13.6

08 Nov 19:35
6139bc4
Compare
Choose a tag to compare
Breaking
  • None.
Enhancements
  • Support documentation generation from .swiftmodule binaries using
    --swift-build-tool symbolgraph with Swift 5.3.
    John Fairhurst
Bug Fixes

0.13.5

06 Jul 10:51
5b094f6
Compare
Choose a tag to compare
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

0.13.4

31 May 10:52
e72cffd
Compare
Choose a tag to compare
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

0.13.3

24 Apr 08:27
b488374
Compare
Choose a tag to compare
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

0.13.2

02 Apr 09:06
3a4421c
Compare
Choose a tag to compare
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

0.13.1

07 Jan 21:39
06a9f2e
Compare
Choose a tag to compare
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 in custom_categories. Defaults to 'Other '.
    JP Simard

  • Add hide_unlisted_documentation configuration setting. Setting this
    to true 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

09 Dec 17:25
0272684
Compare
Choose a tag to compare
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

0.12.0

11 Nov 12:03
04611d3
Compare
Choose a tag to compare
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

0.11.2

25 Sep 12:11
027fc6e
Compare
Choose a tag to compare
Breaking
  • None.
Enhancements
  • None.
Bug Fixes

0.11.1

17 Sep 09:03
e74453a
Compare
Choose a tag to compare
Breaking
  • None.
Enhancements
  • None.
Bug Fixes
  • Don't use SwiftPM if there is an Xcode workspace or project in a non-root
    directory.
    John Fairhurst
    #1103