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
DocFxParams
The parameter type for DocFx.
Record Fields
| Record Field | Description |
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 |