Note: This API documentation is for FAKE version 4. The migration API documentation can be found here. The API documentation for the new fake 5 modules can be found here

DocFxHelper

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

Nested types and modules

TypeDescription
DocFxParams

The parameter type for DocFx.

Functions and values

Function or valueDescription
DocFx(setParams)
Signature: setParams:(DocFxParams -> DocFxParams) -> unit

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

The default parameters