https://github.com/yhkaplan/fastlane-plugin-swift_doc

Generate documentation, documentation coverage, or a class diagram using SwiftDoc
https://github.com/yhkaplan/fastlane-plugin-swift_doc

Last synced: about 1 month ago
JSON representation

Generate documentation, documentation coverage, or a class diagram using SwiftDoc

• Host: GitHub
• URL: https://github.com/yhkaplan/fastlane-plugin-swift_doc
• Owner: yhkaplan
• License: mit
• Created: 2021-04-08T09:45:16.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2021-04-09T05:39:42.000Z (almost 4 years ago)
• Last Synced: 2024-04-24T08:16:23.941Z (9 months ago)
• Language: Ruby
• Size: 16.6 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# swift_doc plugin

[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-swift_doc)

## Getting Started

This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-swift_doc`, add it to your project by running:

```bash

fastlane add_plugin swift_doc

```

## About swift_doc

Generate documentation, documentation coverage, or a class diagram using [SwiftDoc](https://github.com/SwiftDocOrg/swift-doc)

## Example

Check out the [example `Fastfile`](fastlane/Fastfile) to see how to use this plugin. Try it by cloning the repo, running `fastlane install_plugins` and `bundle exec fastlane test`.

## Run tests for this plugin

To run both the tests, and code style validation, run

```

rake

```

To automatically fix many of the styling issues, use

```

rubocop -a

```

## Issues and Feedback

For any other issues and feedback about this plugin, please submit it to this repository.

## Troubleshooting

If you have trouble using plugins, check out the [Plugins Troubleshooting](https://docs.fastlane.tools/plugins/plugins-troubleshooting/) guide.

## Using _fastlane_ Plugins

For more information about how the `fastlane` plugin system works, check out the [Plugins documentation](https://docs.fastlane.tools/plugins/create-plugin/).

## About _fastlane_

_fastlane_ is the easiest way to automate beta deployments and releases for your iOS and Android apps. To learn more, check out [fastlane.tools](https://fastlane.tools).