Haddock is the standard tool for generating documentation from Haskell code.
Full documentation about Haddock itself can be found in the doc/ subdirectory,
in reStructuredText format.
This project consists of three packages:
-
haddock: provides thehaddockexecutable. It is implemented as a tiny wrapper aroundhaddock-api'sDocumentation.Haddock.haddockfunction. -
haddock-api: contains the program logic of thehaddocktool. The haddocks for theDocumentation.Haddockmodule offer a good overview of the functionality. -
haddock-library: is concerned with the parsing and processing of the Haddock markup language. Unlike the other packages, it is expected to build on a fairly wide range of GHC versions.
See CONTRIBUTING.md to see how to make contributions to the project.