Skip to content

Swift Package Documentation Generator

Actions
Generates documentation for a Swift package using docc
v3.2.1
Latest
Star (12)

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

Swift Package Documentation Generator is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.

About

Generates documentation for a Swift package using docc
v3.2.1
Latest

Swift Package Documentation Generator is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.