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

OBSOLETE

FAKE0001 Use the Fake.Documentation.DocFx module instead

DocFxParams

The parameter type for DocFx.

Record Fields

Record FieldDescription
DocFxJson
Signature: string

the DocFxJson Config-File. Default: docs/docfx.json
Serve
Signature: bool

Serves the generated documentation on localhost. Default: false
Timeout
Signature: TimeSpan

Allows to specify a timeout for DocFx. Default: 5 min
ToolPath
Signature: string

The tool path - FAKE tries to find docfx.exe automatically in any sub folder.
WorkingDirectory
Signature: string

DocFx WorkingDirectory. Default: docs