hackage-doc-builder-config

This repository contains configuration and administrative documentation for the documentation builder feeding documentation to https://hackage.haskell.org.

Requesting native libraries

If the documentation for your Hackage package upload fails to build due to a missing native library you have two options:

1. If the library is common, packaged in nixpkgs, and small then you can petition to have it installed on the Hackage documentation builder by opening a merge request adding it to the list of nixpkgs derivation paths in build-depends.nix. These can be found via either search.nixos.org or locally using nix-index.

2. Otherwise you can upload documentation to Hackage manually.

Manual documentation upload

When native library dependencies aren't available on the Hackage documentation builder Haddock documentation can always be manually uploaded to Hackage using cabal-install:

$ cabal haddock --haddock-for-hackage
$ cabal upload --documentation --publish