Stack.Build.Haddock

Generate haddocks

Documentation

generateLocalHaddockIndex

Arguments

:: (HasProcessContext env, HasLogFunc env)

=> WhichCompiler

-> BaseConfigOpts

-> Map GhcPkgId (DumpPackage () () ())

Local package dump

-> [LocalPackage]

-> RIO env ()

Generate Haddock index and contents for local packages.

generateDepsHaddockIndex

Arguments

:: (HasProcessContext env, HasLogFunc env)

=> WhichCompiler

-> BaseConfigOpts

-> Map GhcPkgId (DumpPackage () () ())

Global dump information

-> Map GhcPkgId (DumpPackage () () ())

Snapshot dump information

-> Map GhcPkgId (DumpPackage () () ())

Local dump information

-> [LocalPackage]

-> RIO env ()

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

generateSnapHaddockIndex

Arguments

:: (HasProcessContext env, HasLogFunc env)

=> WhichCompiler

-> BaseConfigOpts

-> Map GhcPkgId (DumpPackage () () ())

Global package dump

-> Map GhcPkgId (DumpPackage () () ())

Snapshot package dump

-> RIO env ()

Generate Haddock index and contents for all snapshot packages.

openHaddocksInBrowser

Arguments

:: HasRunner env

=> BaseConfigOpts

-> Map PackageName (PackageIdentifier, InstallLocation)

Available packages and their locations for the current project

-> Set PackageName

Build targets as determined by loadSourceMap

-> RIO env ()

shouldHaddockPackage

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

Determine whether to build haddocks for dependencies.