standalone-haddock generates standalone haddock Haskell documentation.
Note: you need this program to publish haddocks on your own website. If you want to upload haddocks to hackage instead, follow these instructions.
When you simply run
cabal haddock, the resulting HTML documentation contains
hyperlinks to other packages on your system. As a result, you cannot publish it
on the internet (well, you can, but the links will be broken).
standalone-haddock takes several packages for which you want to publish documentation. It generates documentation for them with proper links:
- links to identifiers inside this package set are relative
- links to identifiers from external packages lead to hackage
Thus the resulting directory with HTML files is relocatable and publishable.
TL;DR: it just works. See the haskell-suite documentation for an example output.
Usage: standalone-haddock [--package-db DB-PATH] -o OUTPUT-PATH [PACKAGE-PATH] Available options: -h,--help Show this help text --package-db DB-PATH Additional package database -o OUTPUT-PATH Directory where html files will be placed
PACKAGE-PATH is the path to the (unpacked) package — i.e. a directory with a
standalone-haddock -o doc haskell-names haskell-packages haskell-src-exts hse-cpp cabal/Cabal
NOTE: dependencies of every package need to be already installed in the system with documentation (even those dependencies that themselves belong to the current package set).
By default, only the global database is read. Other databases can be included
--package-db option. For example, to include the standard local
standalone-haddock -o doc --package-db $HOME/.ghc/i386-linux-7.6.3/package.conf.d pkg1 pkg2
i386-linux-7.6.3 with your platform id).