Skip to content

A GitHub Action that generates documentation for a Swift package using docc.

License

Notifications You must be signed in to change notification settings

sersoft-gmbh/swifty-docs-action

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Repository files navigation

Swift Package Documentation Generator

Tests

This action generates documentation for a Swift package using docc.

Important: The package must use the Swift-DocC Plugin unless xcodebuild is used!

Note: As of version 2, this action uses docc instead of jazzy! Use @v1 to use jazzy.

Inputs

See action.yml for all inputs.

Example Usage

Use the following snippet in a Swift package repository to generate documentation for all products of your Swift package:

uses: sersoft-gmbh/swifty-docs-action@v3
with:
  output: docs