Safe Haskell | None |
---|---|
Language | Haskell2010 |
Generate haddocks
- generateLocalHaddockIndex :: (MonadUnliftIO m, MonadLogger m) => EnvOverride -> WhichCompiler -> BaseConfigOpts -> Map GhcPkgId (DumpPackage () () ()) -> [LocalPackage] -> m ()
- generateDepsHaddockIndex :: (MonadUnliftIO m, MonadLogger m) => EnvOverride -> WhichCompiler -> BaseConfigOpts -> Map GhcPkgId (DumpPackage () () ()) -> Map GhcPkgId (DumpPackage () () ()) -> Map GhcPkgId (DumpPackage () () ()) -> [LocalPackage] -> m ()
- generateSnapHaddockIndex :: (MonadUnliftIO m, MonadLogger m) => EnvOverride -> WhichCompiler -> BaseConfigOpts -> Map GhcPkgId (DumpPackage () () ()) -> Map GhcPkgId (DumpPackage () () ()) -> m ()
- openHaddocksInBrowser :: HasRunner env => BaseConfigOpts -> Map PackageName (PackageIdentifier, InstallLocation) -> Set PackageName -> RIO env ()
- shouldHaddockPackage :: BuildOpts -> Set PackageName -> PackageName -> Bool
- shouldHaddockDeps :: BuildOpts -> Bool
Documentation
generateLocalHaddockIndex Source #
:: (MonadUnliftIO m, MonadLogger m) | |
=> EnvOverride | |
-> WhichCompiler | |
-> BaseConfigOpts | |
-> Map GhcPkgId (DumpPackage () () ()) | Local package dump |
-> [LocalPackage] | |
-> m () |
Generate Haddock index and contents for local packages.
generateDepsHaddockIndex Source #
:: (MonadUnliftIO m, MonadLogger 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 #
:: (MonadUnliftIO m, MonadLogger 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.
openHaddocksInBrowser Source #
:: HasRunner env | |
=> BaseConfigOpts | |
-> Map PackageName (PackageIdentifier, InstallLocation) | Available packages and their locations for the current project |
-> Set PackageName | Build targets as determined by |
-> RIO env () |
:: 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.