@hackage / standalone-haddock

Generate standalone haddock documentation for a set of packages

Latest1.4.0.0

About

Metadata

  • Last updated , by KarlVoelker
  • License MIT
  • Categories Package Distribution

  • Maintained by: Karl Voelker <standalone-haddock@karlv.net>

  • Lottery factor: 0

Links

Installation

Readme

standalone-haddock generates standalone haddock Haskell documentation.

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.