This action generates documentation for a Swift package using docc.

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

Note: Version 2 of this action replaced jazzy with docc! Use @v1 to use jazzy.

The path to the package.
Required. Defaults to ${{github.workspace}}.

The version to use for this package.

Whether to enable inherited docs. Defaults to false.

Enable index building. Defaults to false.

Enables the static hosting transformation. Defaults to false.

The hosting base path to use.

Further (newline-separated) docc arguments.

A list of targets separated by newline. If not given, all targets are built.
This is ignored if use-xcodebuild is true!

Tells the action to use xcodebuild (instead of swift package). Use xcodebuild-scheme and xcodebuild-destination to further customize the xcodebuild invocation.
Defaults to false.
Note: This parameter is only evaluated when running on macOS.

The scheme to use for the xcodebuild invocation. Only used if use-xcodebuild is true.
Note: This parameter is only evaluated when running on macOS.

The destination to use for the xcodebuild invocation. Only used if use-xcodebuild is true.
Note: This parameter is only evaluated when running on macOS.

Further (newline-separated) xcodebuild arguments.

The path to the output directory.

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@v2
with:
  output: docs