stack-2.14.0: The Haskell Tool Stack
Safe HaskellSafe-Inferred
LanguageGHC2021

Stack.Build.Haddock

Description

Generate haddocks

Synopsis

Documentation

generateDepsHaddockIndex Source #

Arguments

:: (HasCompiler env, HasProcessContext env, HasTerm env) 
=> 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.

generateLocalHaddockIndex Source #

Arguments

:: (HasCompiler env, HasProcessContext env, HasTerm env) 
=> BaseConfigOpts 
-> Map GhcPkgId DumpPackage

Local package dump

-> [LocalPackage] 
-> RIO env () 

Generate Haddock index and contents for local packages.

generateSnapHaddockIndex Source #

Arguments

:: (HasCompiler env, HasProcessContext env, HasTerm env) 
=> 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 Source #

Arguments

:: HasTerm 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 () 

shouldHaddockDeps :: BuildOpts -> Bool Source #

Determine whether to build haddocks for dependencies.

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.