+
Skip to content

fwcd/swift-docc-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 DocC Action

Dist

Generates documentation for a Swift package using the swift-docc-plugin.

Usage

To use, make sure that your package includes a dependency on the plugin in your Package.swift:

.package(url: "https://github.com/apple/swift-docc-plugin.git", from: "1.0.0"),

Then include the action in your workflow (make sure that a Swift 5.6+ toolchain is on your PATH, on macOS this should be given, but on Linux you may need to first install it e.g. using setup-swift):

- uses: fwcd/swift-docc-action@v1
  with:
    target: YourTarget
    output: ./docs
    hosting-base-path: yourproject
    disable-indexing: 'true'
    transform-for-static-hosting: 'true'

The generated documentation will be in the ./docs folder. If you wish to host your docs on GitHub Pages, check out this tutorial from the official docs.

About

GitHub Action for generating Swift documentation using DocC

Topics

Resources

License

Stars

Watchers

Forks

Contributors 2

  •  
  •  
点击 这是indexloc提供的php浏览器服务,不要输入任何密码和下载