README.md

docc plugin

Getting Started

This project is a fastlane plugin. To get started with fastlane-plugin-docc, add it to your project by running:

fastlane add_plugin docc

About docc

Automate DocC - documentation for swift frameworks and packages

Example

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

Fastfile

docc(
	scheme: "<The name of your package/library scheme>",
	derived_data_path: "<The path to write the DocC to>"
)

List of all Parameters

Key	Description	default value
scheme	The scheme you want generate DocC for.
derived_data_path	The path to write the DocC to.
destination	The destination of the project (required for swift packages).
configuration	The configuration for building the project (e.g. 'Debug').

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 guide.

Using fastlane Plugins

For more information about how the fastlane plugin system works, check out the Plugins documentation.

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.