| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Stack.Build.Haddock
Description
Generate haddocks
- copyDepHaddocks :: (MonadIO m, MonadLogger m, MonadThrow m, MonadCatch m, MonadBaseControl IO m) => EnvOverride -> [Path Abs Dir] -> PackageIdentifier -> Set (Path Abs Dir) -> m ()
- generateHaddockIndex :: (MonadIO m, MonadCatch m, MonadThrow m, MonadLogger m, MonadBaseControl IO m) => EnvOverride -> BaseConfigOpts -> [LocalPackage] -> m ()
- shouldHaddockPackage :: BuildOpts -> Set PackageName -> PackageName -> Bool
- shouldHaddockDeps :: BuildOpts -> Bool
Documentation
copyDepHaddocks :: (MonadIO m, MonadLogger m, MonadThrow m, MonadCatch m, MonadBaseControl IO m) => EnvOverride -> [Path Abs Dir] -> PackageIdentifier -> Set (Path Abs Dir) -> m () Source
Copy dependencies' haddocks to documentation directory. This way, relative ../$pkg-$ver
links work and it's easy to upload docs to a web server or otherwise view them in a
non-local-filesystem context. We copy instead of symlink for two reasons: (1) symlinks aren't
reliably supported on Windows, and (2) the filesystem containing dependencies' docs may not be
available where viewing the docs (e.g. if building in a Docker container).
generateHaddockIndex :: (MonadIO m, MonadCatch m, MonadThrow m, MonadLogger m, MonadBaseControl IO m) => EnvOverride -> BaseConfigOpts -> [LocalPackage] -> m () Source
Generate Haddock index and contents for local packages.
shouldHaddockPackage :: BuildOpts -> Set PackageName -> PackageName -> Bool Source
Determine whether we should haddock for a package.
shouldHaddockDeps :: BuildOpts -> Bool Source
Determine whether to build haddocks for dependencies.