Pickles

Contains tasks to run the Pickles living documentation generator

Sample usage

1: 
2: 
3: 
4: 
5: 
6: 
7: 
open Fake.Tools

Target "BuildDoc" (fun _ ->
    Pickles.convert (fun p -> { p with
                                FeatureDirectory = currentDirectory @@ "Specs"
                                OutputDirectory = currentDirectory @@ "SpecDocs" })
)
namespace Fake
namespace Fake.Tools
module Pickles

from Fake.Tools
val convert : setParams:(Pickles.PicklesParams -> Pickles.PicklesParams) -> unit

Nested types and modules

TypeDescription
DocumentationFormat
ErrorLevel

Option which allows to specify if failure of pickles should break the build.

PicklesParams

The Pickles parameter type

TestResultsFormat

The format of the test results

Functions and values

Function or valueDescription
Pickles.convert(setParams)
Signature: setParams:(PicklesParams -> PicklesParams) -> unit

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.

Parameters

  • setParams - Function used to manipulate the default PicklesParams value