black4bird/jazzy

Soulful docs for Swift & Objective-C

jazzy is a command-line utility that generates documentation for Swift or Objective-C

About

Both Swift and Objective-C projects are supported.

Objective-C support was recently added, so please report any issues you find.

Instead of parsing your source files, jazzy hooks into Clang and SourceKit to use the AST representation of your code and its comments for more accurate results. The output matches the look and feel of Apple’s official reference documentation, post WWDC 2014.

This project adheres to the Contributor Covenant Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to info@realm.io.

Requirements

• A version of Xcode (6.x or 7.x) capable of building the project you wish to document. It must be installed in a location indexed by Spotlight.

Installation

[sudo] gem install jazzy

Usage

Run jazzy from your command line. Run jazzy -h for a list of additional options.

If your Swift module is the first thing to build, and it builds fine when running xcodebuild without any arguments from the root of your project, then just running jazzy (without any arguments) from the root of your project should succeed too!

You can set options for your project’s documentation in a configuration file, .jazzy.yaml by default. For a detailed explanation and an exhaustive list of all available options, run jazzy --help config.

Supported keywords

Swift header documentation is written in markdown and supports a number of special keywords. For a complete list and examples, see Erica Sadun's post on Swift header documentation in Xcode 7.

For Objective-C documentation the same keywords are supported, but note that the format is slightly different. In Swift you would write - returns:, but in Objective-C you write @return. See Apple's HeaderDoc User Guide for more details. Note: jazzy currently does not support all Objective-C keywords listed in this document.

Swift

Swift documentation is generated by default.

Example

This is how Realm Swift docs are generated:

jazzy \
  --clean \
  --author Realm \
  --author_url https://realm.io \
  --github_url https://github.com/realm/realm-cocoa \
  --github-file-prefix https://github.com/realm/realm-cocoa/tree/v0.96.2 \
  --module-version 0.96.2 \
  --xcodebuild-arguments -scheme,RealmSwift \
  --module RealmSwift \
  --root-url https://realm.io/docs/swift/0.96.2/api/ \
  --output docs/swift_output \
  --theme docs/themes

Objective-C

To generate documentation for Objective-C headers, you must pass the following parameters to jazzy:

• --objc
• --umbrella-header ...
• -framework-root ...
• --sdk [iphone|watch|appletv][os|simulator]|macosx (optional, default value of macosx)

Example

This is how Realm Objective-C docs are generated:

jazzy \
  --objc \
  --clean \
  --author Realm \
  --author_url https://realm.io \
  --github_url https://github.com/realm/realm-cocoa \
  --github-file-prefix https://github.com/realm/realm-cocoa/tree/v0.96.2 \
  --module-version 0.96.2 \
  --umbrella-header Realm/Realm.h \
  --framework-root . \
  --module Realm \
  --root-url https://realm.io/docs/objc/0.96.2/api/ \
  --output docs/objc_output \
  --theme docs/themes

This is how the AFNetworking docs are generated:

jazzy \
  --objc \
  --author AFNetworking \
  --author_url http://afnetworking.com \
  --github_url https://github.com/AFNetworking/AFNetworking \
  --github-file-prefix https://github.com/AFNetworking/AFNetworking/tree/2.6.2 \
  --module-version 2.6.2 \
  --umbrella-header AFNetworking/AFNetworking.h \
  --framework-root . \
  --module AFNetworking

Themes

Two themes are provided with jazzy: apple (default) and fullwidth.

Here's an example built with apple: https://realm.io/docs/swift/latest/api/

Here's an example built with fullwidth: http://reduxkit.github.io/ReduxKit/

You can specify which theme to use by passing in the --theme option. You can also provide your own custom theme by passing in the path to your theme directory.

Guides

Description	Command
Command line option	--documentation={file pattern}
Example	--documentation=Docs/*.md
jazzy.yaml example	documentation: Docs/*.md

Using the --documentation option, extra markdown files can be integrated into the generated docs and sidebar navigation.

Any files found matching the file pattern will be parsed and included as a document with the type 'Guide' when generated. If the files are not included using the custom_categories config option, they will be grouped under 'Other Guides' in the sidebar navigation.

There are a few limitations:

• File names must be unique from source files.
• Readme should be specified separately using the readme_path option.

Section description abstracts

Description	Command
Command line option	--abstract={file pattern}
Example	--abstract=Docs/Sections/*.md
jazzy.yaml example	abstract: Docs/Sections/*.md

Using the --abstract options, extra markdown can be included after the heading of section overview pages. Think of it as a template include.

The list of files matching the pattern is compared against the list of sections generated and if a match is found, it's contents will be included in that section before listing source output.

Unlike the --documentation option, these files are not included in navigation and if a file does not match a section title, it is not included at all.

This is very helpful when using custom_categories for grouping types and including relevant documentation in those sections.

For an example of a project using both --documentation and --abstract see: http://reswift.github.io/ReSwift/

Troubleshooting

Swift

Only extensions are listed in the documentation?

By default, jazzy only documents public declarations. To generate documentation for declarations with a lower accessibility level (internal or private), please set the --min-acl flag to internal or private.

Development

Please review jazzy's contributing guidelines when submitting pull requests.

jazzy is composed of two parts:

1. The parser, SourceKitten (written in Swift)
2. The site generator (written in ruby)

To build and run jazzy from source:

1. Install bundler.
2. Run bundle install from the root of this repo.
3. Run jazzy from source by running bin/jazzy.

Instructions to build SourceKitten from source can be found at SourceKitten's GitHub repository.

Design Goals

• Generate source code docs matching Apple's official reference documentation
• Support for standard Objective-C and Swift documentation comment syntax
• Leverage modern HTML templating (Mustache)
• Leverage the power and accuracy of the Clang AST and SourceKit
• Support for Dash docsets
• Support Swift and Objective-C (mixed projects are a work in progress)

License

This project is released under the MIT license.

About

Jazzy is maintained and funded by Realm Inc. The names and logos for Realm are trademarks of Realm Inc.

We ❤️ open source software! See our other open source projects, read our blog or say hi on twitter (@realm).