Note: This is the migration API reference for FAKE 5. The new (modularized) API documentation can be found here. If the API is already migrated you can check here if exists in a module. More information regarding the migration can be found here

FSFormatting

Contains tasks which allow to run FSharp.Formatting for generating documentation.

Nested types and modules

TypeDescription
LiterateArguments
MetadataFormatArguments

Functions and values

Function or valueDescription
createDocs(p)
Signature: p:(LiterateArguments -> LiterateArguments) -> unit
createDocsForDlls p dllFiles
Signature: p:(MetadataFormatArguments -> MetadataFormatArguments) -> dllFiles:seq<string> -> unit
defaultLiterateArguments
Signature: LiterateArguments
defaultMetadataFormatArguments
Signature: MetadataFormatArguments
run toolPath command
Signature: toolPath:string -> command:string -> unit

Runs fsformatting.exe with the given command in the given repository directory.

toolPath
Signature: string

Specifies the fsformatting executable