stack-1.0.4.2: The Haskell Tool Stack

Safe HaskellNone
LanguageHaskell2010

Stack.Build.Haddock

Description

Generate haddocks

Synopsis

Documentation

generateLocalHaddockIndex Source

Arguments

:: (MonadIO m, MonadCatch m, MonadThrow m, MonadLogger m, MonadBaseControl IO m) 
=> EnvOverride 
-> WhichCompiler 
-> BaseConfigOpts 
-> Map GhcPkgId (DumpPackage () ())

Local package dump

-> [LocalPackage] 
-> m () 

Generate Haddock index and contents for local packages.

generateDepsHaddockIndex Source

Arguments

:: (MonadIO m, MonadCatch m, MonadThrow m, MonadLogger m, MonadBaseControl IO m) 
=> EnvOverride 
-> WhichCompiler 
-> BaseConfigOpts 
-> Map GhcPkgId (DumpPackage () ())

Global dump information

-> Map GhcPkgId (DumpPackage () ())

Snapshot dump information

-> Map GhcPkgId (DumpPackage () ())

Local dump information

-> [LocalPackage] 
-> m () 

Generate Haddock index and contents for local packages and their dependencies.

generateSnapHaddockIndex Source

Arguments

:: (MonadIO m, MonadCatch m, MonadThrow m, MonadLogger m, MonadBaseControl IO m) 
=> EnvOverride 
-> WhichCompiler 
-> BaseConfigOpts 
-> Map GhcPkgId (DumpPackage () ())

Global package dump

-> Map GhcPkgId (DumpPackage () ())

Snapshot package dump

-> m () 

Generate Haddock index and contents for all snapshot packages.

shouldHaddockPackage Source

Arguments

:: BuildOpts 
-> Set PackageName

Packages that we want to generate haddocks for in any case (whether or not we are going to generate haddocks for dependencies)

-> PackageName 
-> Bool 

Determine whether we should haddock for a package.

shouldHaddockDeps :: BuildOpts -> Bool Source

Determine whether to build haddocks for dependencies.