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

DocFxHelper

Contains helper functions to run the documentation tool "docfx".

Nested types and modules

TypeDescription
DocFxParams
OBSOLETE

FAKE0001 Use the Fake.Documentation.DocFx module instead

The parameter type for DocFx.

Functions and values

Function or valueDescription
DocFx(setParams)
Signature: setParams:(DocFxParams -> DocFxParams) -> unit
Attributes:
[<Obsolete("FAKE0001 Use the Fake.Documentation.DocFx module instead")>]
OBSOLETE

FAKE0001 Use the Fake.Documentation.DocFx module instead

Generates a DocFx documentation.

Parameters

  • setParams - Function used to manipulate the default DocFx parameters. See DocFxDefaults

    Sample

    DocFx (fun p -> { p with DocFxJson = "foo" @@ "bar" @@ "docfx.json" Timeout = TimeSpan.FromMinutes 10. })
DocFxDefaults
Signature: DocFxParams
Attributes:
[<Obsolete("FAKE0001 Use the Fake.Documentation.DocFx module instead")>]
OBSOLETE

FAKE0001 Use the Fake.Documentation.DocFx module instead

The default parameters