Pickles Module
Contains tasks to run the Pickles living documentation generator
Example
open Fake.Tools
Target.create "BuildDoc" (fun _ ->
Pickles.convert (fun p ->
{ p with FeatureDirectory = currentDirectory </> "Specs"
OutputDirectory = currentDirectory </> "SpecDocs"
OutputFileFormat = Pickles.DocumentationFormat.DHTML })
)Types
| Type | Description |
The output documentation format |
|
|
Option which allows to specify if failure of pickles should break the build. |
|
|
The Pickles parameter type |
|
|
The format of the test results |
Functions and values
| Function or value | Description |
Full Usage:
Pickles.convert setParams
Parameters:
PicklesParams -> PicklesParams
-
Function used to manipulate the default PicklesParams value
|
Runs pickles living documentation generator via the given tool Will fail if the pickles command line tool terminates with a non zero exit code. The pickles command line tool terminates with a non-zero exit code if there is any error.
|