documentationTarball

pkgs.haskell.lib.documentationTarball

Docs pulled from | This Revision | about 1 hour ago

Create a documentation tarball suitable for uploading to Hackage instead of building the package.

Noogle detected

Implementation

The following is the current implementation of this function.

documentationTarball =
    pkg:
    pkgs.lib.overrideDerivation pkg (drv: {
      name = "${drv.name}-docs";
      # Like sdistTarball, disable the "doc" output here.
      outputs = [ "out" ];
      buildPhase = ''
        runHook preHaddock
        ./Setup haddock --for-hackage
        runHook postHaddock
      '';
      haddockPhase = ":";
      checkPhase = ":";
      installPhase = ''
        runHook preInstall
        mkdir -p "$out"
        tar --format=ustar \
          -czf "$out/${drv.name}-docs.tar.gz" \
          -C dist/doc/html "${drv.name}-docs"
        runHook postInstall
      '';
    });